Package com.ms.gradle.application

Interface ApplicationSpec

All Known Implementing Classes:

Application, ApplicationJar

public interface ApplicationSpec

A specification for building a runnable JAR.

See Also:

Application, ApplicationJar

Method Summary

Modifier and Type	Method	Description
default void	fromSourceSet(Provider<SourceSet> sourceSet)	Configures the application to build from a SourceSet.
default void	fromSourceSet(SourceSet sourceSet)	Configures the application to build from a SourceSet.
Property<Configuration>	getDependencies()	Configuration to resolve the application's dependencies from.
Property<String>	getDependencyDirectoryName()	Name of the directory that will contain the application's dependencies.
Property<String>	getMainClass()	The fully qualified name of the application's main class.
Project	getProject()	Returns the project that this ApplicationSpec belongs to.
Property<Jar>	getRawJar()	Jar task whose output to enhance with the application's classpath and main class metadata.
default Provider<Configuration>	locateDependencies(Provider<SourceSet> sourceSet)	Locates the dependencies configuration associated with the given SourceSet.
default Provider<Configuration>	locateDependencies(SourceSet sourceSet)	Locates the dependencies configuration associated with the given SourceSet.
default Provider<Jar>	locateRawJar(Provider<SourceSet> sourceSet)	Locates the raw JAR task associated with the given SourceSet.
default Provider<Jar>	locateRawJar(SourceSet sourceSet)	Locates the raw JAR task associated with the given SourceSet.

Method Detail

getProject

@Internal
@Nonnull
Project getProject()

Returns the project that this ApplicationSpec belongs to.

Returns:

The project that this ApplicationSpec belongs to.

locateRawJar

@Nonnull
default Provider<Jar> locateRawJar(@Nonnull
                                   SourceSet sourceSet)

Locates the raw JAR task associated with the given SourceSet.

Parameters:

sourceSet - The SourceSet whose raw JAR task to locate.

Returns:

The JAR task of the given SourceSet.

See Also:

locateRawJar(Provider)

locateRawJar

@Nonnull
default Provider<Jar> locateRawJar(@Nonnull
                                   Provider<SourceSet> sourceSet)

Locates the raw JAR task associated with the given SourceSet.

Parameters:

sourceSet - The SourceSet whose raw JAR task to locate.

Returns:

The JAR task of the given SourceSet.

See Also:

locateRawJar(SourceSet)

locateDependencies

@Nonnull
default Provider<Configuration> locateDependencies(@Nonnull
                                                   SourceSet sourceSet)

Locates the dependencies configuration associated with the given SourceSet.

Parameters:

sourceSet - The SourceSet whose dependencies configuration to locate.

Returns:

The runtime classpath configuration of the given SourceSet.

See Also:

locateDependencies(Provider)

locateDependencies

@Nonnull
default Provider<Configuration> locateDependencies(@Nonnull
                                                   Provider<SourceSet> sourceSet)

Locates the dependencies configuration associated with the given SourceSet.

Parameters:

sourceSet - The SourceSet whose dependencies configuration to locate.

Returns:

The runtime classpath configuration of the given SourceSet.

See Also:

locateDependencies(SourceSet)

fromSourceSet

default void fromSourceSet(@Nullable
                           SourceSet sourceSet)

Configures the application to build from a SourceSet.

Calling this method is equivalent to setting the following properties:

• rawJar = locateRawJar(SourceSet)
• dependencies = locateDependencies(SourceSet)

Parameters:

sourceSet - The SourceSet to build the application from.

See Also:

fromSourceSet(Provider)

fromSourceSet

default void fromSourceSet(@Nonnull
                           Provider<SourceSet> sourceSet)

Configures the application to build from a SourceSet.

Calling this method is equivalent to setting the following properties:

• rawJar = locateRawJar(Provider)
• dependencies = locateDependencies(Provider)

Parameters:

sourceSet - The SourceSet to build the application from.

See Also:

fromSourceSet(SourceSet)

getRawJar

@InputFiles
@PathSensitive(NONE)
@Optional
@Nonnull
Property<Jar> getRawJar()

Jar task whose output to enhance with the application's classpath and main class metadata.

Returns:

Property object specifying the application's raw JAR.

See Also:

locateRawJar(SourceSet), fromSourceSet(SourceSet), fromSourceSet(Provider)

getDependencies

@Classpath
@Optional
@Nonnull
Property<Configuration> getDependencies()

Configuration to resolve the application's dependencies from. The application's classpath will consist of the resolved dependency artifact files.

Returns:

Property object specifying the application's dependencies.

See Also:

locateDependencies(SourceSet), fromSourceSet(SourceSet), fromSourceSet(Provider)

getDependencyDirectoryName

@Input
@Nonnull
Property<String> getDependencyDirectoryName()

Name of the directory that will contain the application's dependencies.

Returns:

Property object specifying the application's dependency directory name.

getMainClass

@Input
@Nonnull
Property<String> getMainClass()

The fully qualified name of the application's main class.

Returns:

Property object specifying the application's main class.