Package org.gradle.api.tasks.bundling

# Class War

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.internal.ConventionTask
org.gradle.api.tasks.AbstractCopyTask
org.gradle.api.tasks.bundling.AbstractArchiveTask
org.gradle.api.tasks.bundling.Zip
org.gradle.jvm.tasks.Jar
org.gradle.api.tasks.bundling.Jar
org.gradle.api.tasks.bundling.War

All Implemented Interfaces:
  `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`, `Named`, `ExtensionAware`, `Task`, `PatternFilterable`, `Configurable<Task>`

@DisableCachingByDefault(because="Not worth caching") public abstract class War extends Jar
Assembles a WAR archive.

- ## Nested Class Summary

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

  `Named.Namer`

- ## Field Summary

  Fields
  Modifier and Type
  Field
  Description
  `static final String`
  `WAR_EXTENSION`

  ### Fields inherited from class org.gradle.jvm.tasks.Jar

  `DEFAULT_EXTENSION`

  ### Fields inherited from class org.gradle.api.tasks.bundling.Zip

  `ZIP_EXTENSION`

  ### Fields inherited from interface org.gradle.api.Task

  `TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `War()`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `classpath(@Nullable Object... classpath)`
  Adds files to the classpath to include in the WAR archive.
  `@Nullable FileCollection`
  `getClasspath()`
  Returns the classpath to include in the WAR archive.
  `abstract ObjectFactory`
  `getObjectFactory()`
  `DirectoryProperty`
  `getWebAppDirectory()`
  Returns the app directory of the task.
  `CopySpec`
  `getWebInf()`
  `@Nullable File`
  `getWebXml()`
  Returns the `web.xml` file to include in the WAR archive.
  `void`
  `setClasspath(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(@Nullable 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.

  ### Methods inherited from class org.gradle.api.tasks.bundling.Jar

  `manifest`

  ### Methods inherited from class org.gradle.jvm.tasks.Jar

  `getManifest, getManifestContentCharset, getMetadataCharset, getMetaInf, manifest, metaInf, metaInf, setManifest, setManifestContentCharset, setMetadataCharset`

  ### Methods inherited from class org.gradle.api.tasks.bundling.Zip

  `createCopyAction, getCompressor, getEntryCompression, isZip64, setEntryCompression, setZip64`

  ### Methods inherited from class org.gradle.api.tasks.bundling.AbstractArchiveTask

  `createCopyActionExecuter, getArchiveAppendix, getArchiveBaseName, getArchiveClassifier, getArchiveExtension, getArchiveFile, getArchiveFileName, getArchiveVersion, getDestinationDirectory, getFileSystemOperations, into, into, into, isPreserveFileTimestamps, isReproducibleFileOrder, setPreserveFileTimestamps, setReproducibleFileOrder, useFileSystemPermissions`

  ### Methods inherited from class org.gradle.api.tasks.AbstractCopyTask

  `copy, createRootSpec, dirPermissions, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, expand, filePermissions, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirectoryFileTreeFactory, getDirPermissions, getDocumentationRegistry, getDuplicatesStrategy, getExcludes, getFileLookup, getFilePermissions, getFileResolver, getFileSystem, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getPropertyFactory, getRootSpec, getSource, include, include, include, include, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDuplicatesStrategy, setExcludes, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with`

  ### Methods inherited from class org.gradle.api.internal.ConventionTask

  `conventionMapping, conventionMapping, getConventionMapping`

  ### Methods inherited from class org.gradle.api.DefaultTask

  `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`

  ### Methods inherited from class org.gradle.api.internal.AbstractTask

  `acceptServiceReferences, appendParallelSafeAction, doNotTrackState, doNotTrackStateIf, getAsDynamicObject, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonsNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, restoreOnlyIf, restoreTaskActions, setImpliesSubProjects`

  ### Methods inherited from class java.lang.Object

  `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

  ### Methods inherited from interface org.gradle.api.Task

  `doNotTrackState, notCompatibleWithConfigurationCache`

- ## Field Details

  - ### WAR_EXTENSION

    public static final String WAR_EXTENSION
    See Also:
      - Constant Field Values

- ## Constructor Details

  - ### War

    public War()

- ## Method Details

  - ### getObjectFactory

    @Inject public abstract ObjectFactory getObjectFactory()
    Specified by:
      `getObjectFactory` in class `AbstractCopyTask`

  - ### getWebInf

    @Internal public CopySpec getWebInf()

  - ### webInf

    public CopySpec webInf(@DelegatesTo(CopySpec.class) Closure configureClosure)
    Adds some content to the `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.

    Parameters:
      `configureClosure` - The closure to execute
    Returns:
      The newly created `CopySpec`.

  - ### webInf

    public CopySpec webInf(Action<? super CopySpec> configureAction)
    Adds some content to the `WEB-INF` directory for this WAR archive.

    The given action is executed to configure a `CopySpec`.

    Parameters:
      `configureAction` - The action to execute
    Returns:
      The newly created `CopySpec`.
    Since:
      3.5

  - ### getClasspath

    @Optional @Classpath public @Nullable FileCollection getClasspath()
    Returns the classpath to include in the WAR archive. Any JAR or ZIP files in this classpath are included in the `WEB-INF/lib` directory. Any directories in this classpath are included in the `WEB-INF/classes` directory.
    Returns:
      The classpath. Returns an empty collection when there is no classpath to include in the WAR.

  - ### setClasspath

    public void setClasspath(FileCollection classpath)
    Sets the classpath to include in the WAR archive.
    Parameters:
      `classpath` - The classpath. Must not be null.
    Since:
      4.0

  - ### setClasspath

    public void setClasspath(Object classpath)
    Sets the classpath to include in the WAR archive.
    Parameters:
      `classpath` - The classpath. Must not be null.

  - ### classpath

    public void classpath(@Nullable Object... classpath)
    Adds files to the classpath to include in the WAR archive.
    Parameters:
      `classpath` - The files to add. These are evaluated as per `Project.files(Object...)`

  - ### getWebXml

    @Optional @PathSensitive(NONE) @InputFile public @Nullable File getWebXml()
    Returns the `web.xml` file to include in the WAR archive. When `null`, no `web.xml` file is included in the WAR.
    Returns:
      The `web.xml` file.

  - ### setWebXml

    public void setWebXml(@Nullable File webXml)
    Sets the `web.xml` file to include in the WAR archive. When `null`, no `web.xml` file is included in the WAR.
    Parameters:
      `webXml` - The `web.xml` file. Maybe null.

  - ### getWebAppDirectory

    @Internal public DirectoryProperty getWebAppDirectory()
    Returns the app directory of the task. Added to the output web archive by default.

    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.

    Returns:
      The app directory.
    Since:
      7.1