java.lang.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>@DisableCachingByDefault(because="Not worth caching") public abstract class War extends Jar
Task.Namer| Modifier and Type | Field | Description |
|---|---|---|
static java.lang.String |
WAR_EXTENSION |
DEFAULT_EXTENSIONZIP_EXTENSIONTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE| Constructor | Description |
|---|---|
War() |
| Modifier and Type | Method | Description |
|---|---|---|
void |
classpath(java.lang.Object... classpath) |
Adds files to the classpath to include in the WAR archive.
|
FileCollection |
getClasspath() |
Returns the classpath to include in the WAR archive.
|
ObjectFactory |
getObjectFactory() |
|
DirectoryProperty |
getWebAppDirectory() |
Returns the app directory of the task.
|
CopySpec |
getWebInf() |
|
java.io.File |
getWebXml() |
Returns the
web.xml file to include in the WAR archive. |
void |
setClasspath(java.lang.Object classpath) |
Sets the classpath to include in the WAR archive.
|
void |
setClasspath(FileCollection classpath) |
Sets the classpath to include in the WAR archive.
|
void |
setWebXml(java.io.File webXml) |
Sets the
web.xml file to include in the WAR archive. |
CopySpec |
webInf(Closure configureClosure) |
Adds some content to the
WEB-INF directory for this WAR archive. |
CopySpec |
webInf(Action<? super CopySpec> configureAction) |
Adds some content to the
WEB-INF directory for this WAR archive. |
getManifest, getManifestContentCharset, getMetadataCharset, getMetaInf, manifest, metaInf, metaInf, setManifest, setManifestContentCharset, setMetadataCharsetcreateCopyAction, getCompressor, getEntryCompression, isZip64, setEntryCompression, setZip64createCopyActionExecuter, getArchiveAppendix, getArchiveBaseName, getArchiveClassifier, getArchiveExtension, getArchiveFile, getArchiveFileName, getArchivePath, getArchiveVersion, getDestinationDirectory, into, into, into, isPreserveFileTimestamps, isReproducibleFileOrder, setPreserveFileTimestamps, setReproducibleFileOrdercopy, createRootSpec, dirPermissions, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, expand, filePermissions, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirectoryFileTreeFactory, getDirMode, getDirPermissions, getDocumentationRegistry, getDuplicatesStrategy, getExcludes, getFileLookup, getFileMode, getFilePermissions, getFileResolver, getFileSystem, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getRootSpec, getSource, include, include, include, include, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, withconventionMapping, conventionMapping, getConventionMappingcompareTo, 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, usesServiceacceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdoNotTrackState, getConvention, notCompatibleWithConfigurationCachepublic static final java.lang.String WAR_EXTENSION
@Inject public ObjectFactory getObjectFactory()
getObjectFactory in class AbstractCopyTaskpublic CopySpec webInf(@DelegatesTo(CopySpec.class) Closure configureClosure)
WEB-INF directory for this WAR archive.
The given closure is executed to configure a CopySpec. The CopySpec is passed to the closure as its delegate.
configureClosure - The closure to executeCopySpec.public CopySpec webInf(Action<? super CopySpec> configureAction)
WEB-INF directory for this WAR archive.
The given action is executed to configure a CopySpec.
configureAction - The action to executeCopySpec.@Nullable @Optional @Classpath public FileCollection getClasspath()
WEB-INF/lib directory. Any directories in this classpath are included in
the WEB-INF/classes directory.public void setClasspath(FileCollection classpath)
classpath - The classpath. Must not be null.public void setClasspath(java.lang.Object classpath)
classpath - The classpath. Must not be null.public void classpath(java.lang.Object... classpath)
classpath - The files to add. These are evaluated as per Project.files(Object...)@Nullable @Optional @PathSensitive(NONE) @InputFile public java.io.File getWebXml()
web.xml file to include in the WAR archive. When null, no web.xml file is included in the WAR.web.xml file.public void setWebXml(@Nullable
java.io.File webXml)
web.xml file to include in the WAR archive. When null, no web.xml file is included in the WAR.webXml - The web.xml file. Maybe null.@Internal public DirectoryProperty getWebAppDirectory()
The war plugin sets the default value for all War tasks to src/main/webapp and adds it as a task input.
Note, that if the war plugin is not applied then this property is ignored. In that case, clients can manually set an app directory as a task input.