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
- 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
,ExtensionAware
,Task
,PatternFilterable
,org.gradle.util.Configurable<Task>
Assembles a WAR archive.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.gradle.api.Task
Task.Namer
-
Field Summary
FieldsFields 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_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds files to the classpath to include in the WAR archive.Returns the classpath to include in the WAR archive.Returns theweb.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
Sets theweb.xml
file to include in the WAR archive.Adds some content to theWEB-INF
directory for this WAR archive.Adds some content to theWEB-INF
directory for this WAR archive.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, getAppendix, getArchiveName, getArchivePath, getBaseName, getClassifier, getDestinationDir, getExtension, getVersion, into, into, into, isPreserveFileTimestamps, isReproducibleFileOrder, setAppendix, setArchiveName, setBaseName, setClassifier, setDestinationDir, setExtension, setPreserveFileTimestamps, setReproducibleFileOrder, setVersion
Methods inherited from class org.gradle.api.tasks.AbstractCopyTask
copy, createRootSpec, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirectoryFileTreeFactory, getDirMode, getDuplicatesStrategy, getExcludes, getFileLookup, getFileMode, 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, with
Methods inherited from class org.gradle.api.internal.ConventionTask
conventionMapping, conventionMapping, getConventionMapping
Methods inherited from class org.gradle.api.DefaultTask
newInputDirectory, newInputFile, newOutputDirectory, newOutputFile
Methods inherited from class org.gradle.api.internal.AbstractTask
addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString
-
Field Details
-
WAR_EXTENSION
- See Also:
-
-
Constructor Details
-
War
public War()
-
-
Method Details
-
getWebInf
-
webInf
Adds some content to theWEB-INF
directory for this WAR archive.The given closure is executed to configure a
CopySpec
. TheCopySpec
is passed to the closure as its delegate.- Parameters:
configureClosure
- The closure to execute- Returns:
- The newly created
CopySpec
.
-
webInf
Adds some content to theWEB-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
Returns the classpath to include in the WAR archive. Any JAR or ZIP files in this classpath are included in theWEB-INF/lib
directory. Any directories in this classpath are included in theWEB-INF/classes
directory.- Returns:
- The classpath. Returns an empty collection when there is no classpath to include in the WAR.
-
setClasspath
Sets the classpath to include in the WAR archive.- Parameters:
classpath
- The classpath. Must not be null.- Since:
- 4.0
-
setClasspath
Sets the classpath to include in the WAR archive.- Parameters:
classpath
- The classpath. Must not be null.
-
classpath
Adds files to the classpath to include in the WAR archive.- Parameters:
classpath
- The files to add. These are evaluated as perProject.files(Object...)
-
getWebXml
Returns theweb.xml
file to include in the WAR archive. Whennull
, noweb.xml
file is included in the WAR.- Returns:
- The
web.xml
file.
-
setWebXml
Sets theweb.xml
file to include in the WAR archive. Whennull
, noweb.xml
file is included in the WAR.- Parameters:
webXml
- Theweb.xml
file. Maybe null.
-