diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/allclasses-index.html b/allclasses-index.html new file mode 100644 index 0000000..b475063 --- /dev/null +++ b/allclasses-index.html @@ -0,0 +1,184 @@ + + + +
+ +Class | +Description | +
---|---|
Application | +
+ An
+Application is a specification for building a runnable JAR (meaning one that java -jar is able to
+ execute directly). |
+
ApplicationJar | +
+ Assembles an application JAR archive.
+ |
+
ApplicationName | +
+ Attribute to define the application name.
+ |
+
ApplicationPlugin | +
+ Gradle
+Plugin class that implements
+ Morgan Stanley's Application plugin. |
+
ApplicationSpec | +
+ A specification for building a runnable JAR.
+ |
+
Package | +Description | +
---|---|
com.ms.gradle.application | ++ |
ApplicationSpec
, Named
public abstract class Application +extends Object +implements ApplicationSpec, Named+
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.ApplicationJar
,
+JAR Files as ApplicationsNamed.Namer
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 | +Description | +
---|---|
Application(Project project,
+ String name) |
+
+ Creates an
+Application instance. |
+
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. |
+
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
fromSourceSet, fromSourceSet, getDependencies, getDependencyDirectoryName, getMainClass, getRawJar, locateDependencies, locateDependencies, locateRawJar, locateRawJar
public static final String APPLICATION+
public static final String MAIN_APPLICATION_NAME+
public static final String MAIN_APPLICATION_JAR_TASK_NAME+
public static final String MAIN_APPLICATION_CONFIGURATION_NAME+
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).LibraryElements.JAR
,
+Constant Field Values@Inject +public Application(@Nonnull + Project project, + @Nonnull + String name)+
Application
instance.project
- The project that the application belongs to.name
- The name of the application.@Nonnull +public Project getProject()+
getProject
in interface ApplicationSpec
@Nonnull +public String toString()+
Application
that can be used in log and error messages.toString
in class Object
Application
.@Nullable +public String getDescription()+
public void setDescription(@Nullable + String description)+
description
- The description of the application.@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:
+"${project.name}"
."${project.name}-${this.name}"
.Property
object specifying the application's base name.Distribution.getDistributionBaseName()
@Nonnull +public TaskProvider<ApplicationJar> getApplicationJar()+
ApplicationJar
for the application.ApplicationJar
for the application.public void applicationJar(@Nonnull + Action<? super ApplicationJar> action)+
ApplicationJar
for the application.action
- Action to configure the ApplicationJar
.@Nonnull +public NamedDomainObjectProvider<Configuration> getConfiguration()+
Configuration
for the application, representing its runtime elements
+ (application JAR artifact and its dependencies).Configuration
for the application.applicationJar
,
+dependencies
public void configuration(@Nonnull + Action<? super Configuration> action)+
Configuration
for the application.action
- Action to configure the Configuration
.@Nonnull +public NamedDomainObjectProvider<Distribution> getDistribution()+
Distribution
for the application.Distribution
for the application.public void distribution(@Nonnull + Action<? super Distribution> action)+
Distribution
for the application.action
- Action to configure the Distribution
.public void finalizeProperties()+
IllegalStateException
.GradleException
- If the application's configuration is invalid.Property.finalizeValue()
ApplicationSpec
, Comparable<Task>
, ContentFilterable
, CopyProcessingSpec
, CopySourceSpec
, CopySpec
, org.gradle.api.internal.DynamicObjectAware
, org.gradle.api.internal.file.copy.CopySpecSource
, org.gradle.api.internal.IConventionAware
, org.gradle.api.internal.TaskInternal
, ExtensionAware
, Task
, PatternFilterable
, Configurable<Task>
@CacheableTask +public abstract class ApplicationJar +extends Jar +implements ApplicationSpec+
Task.Namer
Modifier and Type | +Field | +Description | +
---|---|---|
static String |
+APPLICATION_DIRECTORY_NAME |
+
+ Name of the build directory where the application JARs will be generated by default.
+ |
+
static String |
+DEPENDENCY_DIRECTORY_NAME |
+
+ Name of the subdirectory where the dependencies will be placed by default.
+ |
+
DEFAULT_EXTENSION
ZIP_EXTENSION
TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
Constructor | +Description | +
---|---|
ApplicationJar() |
+
+ Creates an
+ApplicationJar task. |
+
Modifier and Type | +Method | +Description | +
---|---|---|
CopySpec |
+applicationCopySpec() |
+
+ Creates a new
+CopySpec that can be used to copy the application JAR generated by this task, along with
+ its dependency artifact files, to an organized directory structure that allows the application to be run. |
+
void |
+finalizeProperties() |
+
+ Finalizes the properties of this task.
+ |
+
getManifest, getManifestContentCharset, getMetadataCharset, getMetaInf, manifest, metaInf, metaInf, setManifest, setManifestContentCharset, setMetadataCharset
getEntryCompression, isZip64, setEntryCompression, setZip64
getArchiveAppendix, getArchiveBaseName, getArchiveClassifier, getArchiveExtension, getArchiveFile, getArchiveFileName, getArchivePath, getArchiveVersion, getDestinationDirectory, into, into, into, isPreserveFileTimestamps, isReproducibleFileOrder, setPreserveFileTimestamps, setReproducibleFileOrder
dirPermissions, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, expand, filePermissions, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirMode, getDirPermissions, getDuplicatesStrategy, getExcludes, getFileMode, getFilePermissions, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getRootSpec, getSource, include, include, include, include, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with
conventionMapping, conventionMapping, getConventionMapping
compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService
acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
fromSourceSet, fromSourceSet, getDependencies, getDependencyDirectoryName, getMainClass, getProject, getRawJar, locateDependencies, locateDependencies, locateRawJar, locateRawJar
doNotTrackState, getConvention, notCompatibleWithConfigurationCache
public static final String APPLICATION_DIRECTORY_NAME+
public static final String DEPENDENCY_DIRECTORY_NAME+
@Inject +public ApplicationJar()+
ApplicationJar
task.@Nonnull +public CopySpec applicationCopySpec()+
Creates a new CopySpec
that can be used to copy the application JAR generated by this task, along with
+ its dependency artifact files, to an organized directory structure that allows the application to be run.
The application JAR will be copied to the destination directory, while dependency artifact files will end up
+ in a subdirectory whose name can be set through the dependencyDirectoryName
+ property. Within that directory, the relative path of dependency artifact files is specified by
+ Dependency.relativePath
.
Note that in order to avoid resolving the dependencies
configuration too early, the
+ destination paths of dependency artifact files are generated lazily using an eachFile
+ action. Since these actions are executed in the order they were registered in, if a custom one gets added to the
+ CopySpec
returned by this method, it will have access to the final destination paths. However, if the
+ returned CopySpec
itself gets added to another one as a child spec, and the
+ parent spec has an eachFile
action of its own, that will not see the final
+ destination paths, because Gradle executes actions registered on the parent spec before those on the child.
As a general rule, avoid changing the destination paths or excluding files, because doing so may result in
+ missing dependencies at runtime, causing the application to throw exceptions such as NoClassDefFoundError
+ or ClassNotFoundException
.
CopySpec
.ApplicationSpec.getDependencyDirectoryName()
public void finalizeProperties()+
IllegalStateException
.Property.finalizeValue()
Named
public interface ApplicationName +extends Named+
LibraryElements
attribute valued at "application-jar".TestSuiteName
Named.Namer
Modifier and Type | +Field | +Description | +
---|---|---|
static Attribute<ApplicationName> |
+APPLICATION_NAME_ATTRIBUTE |
++ |
static final Attribute<ApplicationName> APPLICATION_NAME_ATTRIBUTE+
Modifier and Type | +Field | +Description | +
---|---|---|
static String |
+EXTENSION_NAME |
+
+ Name of the project extension (
+Application container) that this plugin provides. |
+
static TypeOf<NamedDomainObjectContainer<Application>> |
+EXTENSION_TYPE |
+
+ Type of the project extension (
+Application container) that this plugin provides. |
+
static String |
+TASK_GROUP |
+
+ Name of the task group that this plugin uses.
+ |
+
Constructor | +Description | +
---|---|
ApplicationPlugin() |
++ |
Modifier and Type | +Method | +Description | +
---|---|---|
void |
+apply(Project project) |
+
+ Apply this plugin to the given project.
+ |
+
NamedDomainObjectContainer<Application> |
+getApplications() |
+
+ This method allows type-safe programmatic access to the
+Application container used by this plugin. |
+
public static final String TASK_GROUP+
public static final String EXTENSION_NAME+
Name of the project extension (Application
container) that this plugin provides.
Usage: project.getExtensions().getByName(ApplicationPlugin.EXTENSION_NAME)
getApplications()
,
+EXTENSION_TYPE
,
+Constant Field Valuespublic static final TypeOf<NamedDomainObjectContainer<Application>> EXTENSION_TYPE+
Type of the project extension (Application
container) that this plugin provides.
Usage: project.getExtensions().getByType(ApplicationPlugin.EXTENSION_TYPE)
getApplications()
,
+EXTENSION_NAME
public void apply(@Nonnull + Project project)+
@Nonnull +public NamedDomainObjectContainer<Application> getApplications()+
This method allows type-safe programmatic access to the Application
container used by this plugin.
Usage: project.getPlugins().getPlugin(ApplicationPlugin.class).getApplications()
Application
container used by this plugin.EXTENSION_NAME
,
+EXTENSION_TYPE
Application
, ApplicationJar
public interface ApplicationSpec
+Application
,
+ApplicationJar
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) |
++ + | +
default Provider<Jar> |
+locateRawJar(SourceSet sourceSet) |
++ + | +
@Internal +@Nonnull +Project getProject()+
ApplicationSpec
belongs to.ApplicationSpec
belongs to.@Nonnull +default Provider<Jar> locateRawJar(@Nonnull + SourceSet sourceSet)+ +
sourceSet
- The SourceSet
whose raw JAR task to locate.SourceSet
.locateRawJar(Provider)
@Nonnull +default Provider<Jar> locateRawJar(@Nonnull + Provider<SourceSet> sourceSet)+ +
sourceSet
- The SourceSet
whose raw JAR task to locate.SourceSet
.locateRawJar(SourceSet)
@Nonnull +default Provider<Configuration> locateDependencies(@Nonnull + SourceSet sourceSet)+
SourceSet
.sourceSet
- The SourceSet
whose dependencies configuration to locate.SourceSet
.locateDependencies(Provider)
@Nonnull +default Provider<Configuration> locateDependencies(@Nonnull + Provider<SourceSet> sourceSet)+
SourceSet
.sourceSet
- The SourceSet
whose dependencies configuration to locate.SourceSet
.locateDependencies(SourceSet)
default void fromSourceSet(@Nullable + SourceSet sourceSet)+
Configures the application to build from a SourceSet
.
Calling this method is equivalent to setting the following properties:
+sourceSet
- The SourceSet
to build the application from.fromSourceSet(Provider)
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:
+sourceSet
- The SourceSet
to build the application from.fromSourceSet(SourceSet)
@InputFiles +@PathSensitive(NONE) +@Optional +@Nonnull +Property<Jar> getRawJar()+
Jar
task whose output to enhance with the application's classpath and main class metadata.Property
object specifying the application's raw JAR.locateRawJar(SourceSet)
,
+fromSourceSet(SourceSet)
,
+fromSourceSet(Provider)
@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.Property
object specifying the application's dependencies.locateDependencies(SourceSet)
,
+fromSourceSet(SourceSet)
,
+fromSourceSet(Provider)
@Input +@Nonnull +Property<String> getDependencyDirectoryName()+
Property
object specifying the application's dependency directory name.Interface | +Description | +
---|---|
ApplicationName | +
+ Attribute to define the application name.
+ |
+
ApplicationSpec | +
+ A specification for building a runnable JAR.
+ |
+
Class | +Description | +
---|---|
Application | +
+ An
+Application is a specification for building a runnable JAR (meaning one that java -jar is able to
+ execute directly). |
+
ApplicationJar | +
+ Assembles an application JAR archive.
+ |
+
ApplicationPlugin | +
+ Gradle
+Plugin class that implements
+ Morgan Stanley's Application plugin. |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final String |
+APPLICATION |
+"application" |
+
+
+public static final String |
+LIBRARY_ELEMENTS_APPLICATION_JAR |
+"application-jar" |
+
+
+public static final String |
+MAIN_APPLICATION_CONFIGURATION_NAME |
+"application" |
+
+
+public static final String |
+MAIN_APPLICATION_NAME |
+"main" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final String |
+APPLICATION_DIRECTORY_NAME |
+"application" |
+
+
+public static final String |
+DEPENDENCY_DIRECTORY_NAME |
+"lib" |
+
Modifier and Type | +Constant Field | +Value | +
---|---|---|
+
+public static final String |
+EXTENSION_NAME |
+"applications" |
+
+
+public static final String |
+TASK_GROUP |
+"application" |
+
Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object
. Interfaces do not inherit from java.lang.Object
.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+You can search for definitions of modules, packages, types, fields, methods and other terms defined in the API, using some or all of the name. "Camel-case" abbreviations are supported: for example, "InpStr" will find "InputStream" and "InputStreamReader".
+Application
is a specification for building a runnable JAR (meaning one that java -jar
is able to
+ execute directly).Application
instance.CopySpec
that can be used to copy the application JAR generated by this task, along with
+ its dependency artifact files, to an organized directory structure that allows the application to be run.ApplicationJar
for the application.ApplicationJar
task.Plugin
class that implements
+ Morgan Stanley's Application plugin.Configuration
for the application.Distribution
for the application.Application
container) that this plugin provides.Application
container) that this plugin provides.SourceSet
.SourceSet
.ApplicationJar
for the application.Application
container used by this plugin.Configuration
for the application, representing its runtime elements
+ (application JAR artifact and its dependencies).Configuration
to resolve the application's dependencies from.Distribution
for the application.ApplicationSpec
belongs to.Jar
task whose output to enhance with the application's classpath and main class metadata.LibraryElements
attribute value indicating a JAR
artifact that can be started
+ directly as an application (using the java -jar
command).SourceSet
.SourceSet
.Application
that can be used in log and error messages.