Package com.ms.gradle.application

Class Application

java.lang.Object

com.ms.gradle.application.Application

All Implemented Interfaces:

ApplicationSpec, Named

public abstract class Application
extends Object
implements ApplicationSpec, Named

An Application is a specification for building a runnable JAR (meaning one that java -jar is able to execute directly). Based on the specification, Gradle will make an exact copy of an existing Jar task's output, add the necessary attributes to the copy's Manifest, and set up a Distribution to bundle this enhanced JAR with its dependencies.

See Also:

ApplicationJar, JAR Files as Applications

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.Named

Named.Namer

Field Summary

Fields

Modifier and Type	Field	Description
static String	APPLICATION	Identifier to be used in names.
static String	LIBRARY_ELEMENTS_APPLICATION_JAR	LibraryElements attribute value indicating a JAR artifact that can be started directly as an application (using the java -jar command).
static String	MAIN_APPLICATION_CONFIGURATION_NAME	Name of the main application configuration.
static String	MAIN_APPLICATION_JAR_TASK_NAME	Name of the main application JAR task.
static String	MAIN_APPLICATION_NAME	Name of the main application.

Constructor Summary

Constructors

Constructor	Description
Application(Project project, String name)	Creates an Application instance.

Method Summary

Modifier and Type	Method	Description
void	applicationJar(Action<? super ApplicationJar> action)	Configures the ApplicationJar for the application.
void	configuration(Action<? super Configuration> action)	Configures the Configuration for the application.
void	distribution(Action<? super Distribution> action)	Configures the Distribution for the application.
void	finalizeProperties()	Finalizes and validates the properties of this application.
abstract Property<String>	getApplicationBaseName()	The base name of this application, used in naming the application JAR and the distribution archives.
TaskProvider<ApplicationJar>	getApplicationJar()	Returns the ApplicationJar for the application.
NamedDomainObjectProvider<Configuration>	getConfiguration()	Returns the Configuration for the application, representing its runtime elements (application JAR artifact and its dependencies).
String	getDescription()	Returns the description of the application (for informational purposes).
NamedDomainObjectProvider<Distribution>	getDistribution()	Returns the Distribution for the application.
String	getName()	Returns the name of this application.
Project	getProject()	Returns the project this application belongs to.
void	setDescription(String description)	Sets the description of the application (for informational purposes).
String	toString()	Returns the display name of this Application that can be used in log and error messages.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ms.gradle.application.ApplicationSpec

fromSourceSet, fromSourceSet, getDependencies, getDependencyDirectoryName, getMainClass, getRawJar, locateDependencies, locateDependencies, locateRawJar, locateRawJar

Field Detail

APPLICATION

public static final String APPLICATION

Identifier to be used in names.

See Also:

Constant Field Values

MAIN_APPLICATION_NAME

public static final String MAIN_APPLICATION_NAME

Name of the main application.

See Also:

Constant Field Values

MAIN_APPLICATION_JAR_TASK_NAME

public static final String MAIN_APPLICATION_JAR_TASK_NAME

Name of the main application JAR task.

MAIN_APPLICATION_CONFIGURATION_NAME

public static final String MAIN_APPLICATION_CONFIGURATION_NAME

Name of the main application configuration.

See Also:

Constant Field Values

LIBRARY_ELEMENTS_APPLICATION_JAR

public static final String LIBRARY_ELEMENTS_APPLICATION_JAR

LibraryElements attribute value indicating a JAR artifact that can be started directly as an application (using the java -jar command).

See Also:

JAR Files as Applications, LibraryElements.JAR, Constant Field Values

Constructor Detail

Application

@Inject
public Application(@Nonnull
                   Project project,
                   @Nonnull
                   String name)

Creates an Application instance.

Parameters:

project - The project that the application belongs to.

name - The name of the application.

Method Detail

getProject

@Nonnull
public Project getProject()

Returns the project this application belongs to.

Specified by:

getProject in interface ApplicationSpec

Returns:

The project this application belongs to.

getName

@Nonnull
public String getName()

Returns the name of this application.

Specified by:

getName in interface Named

Returns:

The name of this application.

toString

@Nonnull
public String toString()

Returns the display name of this Application that can be used in log and error messages.

Overrides:

toString in class Object

Returns:

The display name of this Application.

getDescription

@Nullable
public String getDescription()

Returns the description of the application (for informational purposes).

Returns:

The description of the application.

setDescription

public void setDescription(@Nullable
                           String description)

Sets the description of the application (for informational purposes).

Parameters:

description - The description of the application.

getApplicationBaseName

@Nonnull
public abstract Property<String> getApplicationBaseName()

The base name of this application, used in naming the application JAR and the distribution archives.

The default value is as follows:

• For the main application, it is "${project.name}".
• For other applications, it is "${project.name}-${this.name}".

Returns:

Property object specifying the application's base name.

See Also:

Distribution.getDistributionBaseName()

getApplicationJar

@Nonnull
public TaskProvider<ApplicationJar> getApplicationJar()

Returns the ApplicationJar for the application.

Returns:

The ApplicationJar for the application.

applicationJar

public void applicationJar(@Nonnull
                           Action<? super ApplicationJar> action)

Configures the ApplicationJar for the application.

Parameters:

action - Action to configure the ApplicationJar.

getConfiguration

@Nonnull
public NamedDomainObjectProvider<Configuration> getConfiguration()

Returns the Configuration for the application, representing its runtime elements (application JAR artifact and its dependencies).

Returns:

The Configuration for the application.

See Also:

applicationJar, dependencies

configuration

public void configuration(@Nonnull
                          Action<? super Configuration> action)

Configures the Configuration for the application.

Parameters:

action - Action to configure the Configuration.

getDistribution

@Nonnull
public NamedDomainObjectProvider<Distribution> getDistribution()

Returns the Distribution for the application.

Returns:

The Distribution for the application.

distribution

public void distribution(@Nonnull
                         Action<? super Distribution> action)

Configures the Distribution for the application.

Parameters:

action - Action to configure the Distribution.

finalizeProperties

public void finalizeProperties()

Finalizes and validates the properties of this application. Any further attempts to make changes will result in an IllegalStateException.

Throws:

GradleException - If the application's configuration is invalid.

See Also:

Property.finalizeValue()