Movatterモバイル変換


[0]ホーム

URL:


War

API Documentation:War

Assembles a WAR archive.

Properties

PropertyDescription
archiveAppendix

The appendix part of the archive name, if any.

archiveBaseName

The base name of the archive.

archiveClassifier

The classifier part of the archive name, if any.

archiveExtension

The extension part of the archive name.

archiveFile

TheRegularFile where the archive is constructed.The path is simply thedestinationDirectory plus thearchiveFileName.

archiveFileName

The archive name. If the name has not been explicitly set, the pattern for the name is:[archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]

archiveVersion

The version part of the archive name.

caseSensitive

Specifies whether case-sensitive pattern matching should be used.

classpath

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 intheWEB-INF/classes directory.

destinationDirectory

The directory where the archive will be placed.

dirPermissions

Property for querying and configuring directory access permissions.If the property has no value set, that means that existing permissions are preserved.It is dependent on the copy action implementation whether these permissions will actually be applied.For details seeConfigurableFilePermissions.

duplicatesStrategy

The strategy to use when trying to copy more than one file to the same destination.

entryCompression

The compression level of the entries of the archive. If set toZipEntryCompression.DEFLATED (the default), each entry iscompressed using the DEFLATE algorithm. If set toZipEntryCompression.STORED the entries of the archive are left uncompressed.

excludes

The set of exclude patterns.

filePermissions

Property for querying and configuring file access permissions.If the property has no value set, that means that existing permissions are preserved.It is dependent on the copy action implementation whether these permissions will actually be applied.For details seeConfigurableFilePermissions.

includeEmptyDirs

Tells if empty target directories will be included in the copy.

includes

The set of include patterns.

manifest

The manifest for this JAR archive.

metadataCharset

The character set used to encode JAR metadata like file names.Defaults to UTF-8.You can change this property but it is not recommended as JVMs expect JAR metadata to be encoded using UTF-8

preserveFileTimestamps

Specifies whether file timestamps should be preserved in the archive.

reproducibleFileOrder

Specifies whether to enforce a reproducible file order when reading files from directories.

source

The source files for this task.

webXml

Theweb.xml file to include in the WAR archive. Whennull, noweb.xml file is included in the WAR.

zip64

Whether the zip can contain more than 65535 files and/or support files greater than 4GB in size.

Methods

MethodDescription
classpath(classpath)

Adds files to the classpath to include in the WAR archive.

eachFile(closure)

Adds an action to be applied to each file as it about to be copied into its destination. The given closure iscalled with aFileCopyDetails as its parameter. Actions are executed in the orderadded, and are inherited from the parent spec.

eachFile(action)

Adds an action to be applied to each file as it is about to be copied into its destination. The action can changethe destination path of the file, filter the contents of the file, or exclude the file from the result entirely.Actions are executed in the order added, and are inherited from the parent spec.

exclude(excludeSpec)

Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed aFileTreeElement as its parameter. The closure should return true or false. Example:

exclude(excludes)

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.

exclude(excludes)

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.

exclude(excludeSpec)

Adds an exclude spec. This method may be called multiple times to append new specs.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.

expand(properties)

Expands property references in each file as it is copied. More specifically, each file is transformed usingGroovy'sSimpleTemplateEngine. This means you can use simple property references, such as$property or${property} in the file. You can also include arbitrary Groovy code in thefile, such as${version ?: 'unknown'} or${classpath*.name.join(' ')}

expand(properties, action)

Expands property references in each file as it is copied. More specifically, each file is transformed usingGroovy'sSimpleTemplateEngine. This means you can use simple property references, such as$property or${property} in the file. You can also include arbitrary Groovy code in thefile, such as${version ?: 'unknown'} or${classpath*.name.join(' ')}. The templateengine can be configured with the provided action.

filesMatching(patterns, action)

Configure theFileCopyDetails for each file whose path matches any of the specified Ant-style patterns.This is equivalent to using eachFile() and selectively applying a configuration based on the file's path.

filesMatching(pattern, action)

Configure theFileCopyDetails for each file whose path matches the specified Ant-style pattern.This is equivalent to using eachFile() and selectively applying a configuration based on the file's path.

filesNotMatching(patterns, action)

Configure theFileCopyDetails for each file whose path does not match any of the specifiedAnt-style patterns. This is equivalent to using eachFile() and selectively applying a configuration based on thefile's path.

filesNotMatching(pattern, action)

Configure theFileCopyDetails for each file whose path does not match the specifiedAnt-style pattern. This is equivalent to using eachFile() and selectively applying a configuration based on thefile's path.

filter(closure)

Adds a content filter based on the provided closure. The Closure will be called with each line (stripped of lineendings) and should return a String to replace the line ornull to remove the line. If every line isremoved, the result will be an empty file, not an absent one.

filter(filterType)

Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to thefilter chain. Each filter should implementjava.io.FilterReader. Includeorg.apache.tools.ant.filters.* for access to all the standard Ant filters.

filter(properties, filterType)

Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to thefilter chain. Each filter should implementjava.io.FilterReader. Includeorg.apache.tools.ant.filters.* for access to all the standard Ant filters.

filter(transformer)

Adds a content filter based on the provided transformer. The Closure will be called with each line (stripped of lineendings) and should return a String to replace the line ornull to remove the line. If every line isremoved, the result will be an empty file, not an absent one.

from(sourcePath, c)

Specifies the source files or directories for a copy and creates a childCopySourceSpec. The given sourcepath is evaluated as perProject.files(java.lang.Object[]) .

from(sourcePath, configureAction)

Specifies the source files or directories for a copy and creates a childCopySpec. The given sourcepath is evaluated as perProject.files(java.lang.Object[]) .

from(sourcePaths)

Specifies source files or directories for a copy. The given paths are evaluated as perProject.files(java.lang.Object[]).

include(includeSpec)

Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed aFileTreeElement as its parameter.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included.

include(includes)

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed.

include(includes)

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed.

include(includeSpec)

Adds an include spec. This method may be called multiple times to append new specs.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included.

into(destPath)

Specifies the destination directory *inside* the archive for the files.The destination is evaluated as perProject.file(java.lang.Object).Don't mix it up withAbstractArchiveTask.getDestinationDirectory() which specifies the output directory for the archive.

into(destPath, configureClosure)

Creates and configures a childCopySpec with a destination directory *inside* the archive for the files.The destination is evaluated as perProject.file(java.lang.Object).Don't mix it up withAbstractArchiveTask.getDestinationDirectory() which specifies the output directory for the archive.

into(destPath, copySpec)

Creates and configures a childCopySpec with a destination directory *inside* the archive for the files.The destination is evaluated as perProject.file(java.lang.Object).Don't mix it up withAbstractArchiveTask.getDestinationDirectory() which specifies the output directory for the archive.

manifest(configureClosure)

Configures the manifest for this JAR archive.

manifest(configureAction)

Configures the manifest for this JAR archive.

metaInf(configureClosure)

Adds content to this JAR archive's META-INF directory.

metaInf(configureAction)

Adds content to this JAR archive's META-INF directory.

rename(closure)

Renames a source file. The closure will be called with a single parameter, the name of the file.The closure should return a String object with a new target name. The closure may return null,in which case the original name will be used.

rename(sourceRegEx, replaceWith)

Renames files based on a regular expression. Uses java.util.regex type of regular expressions. Note that thereplace string should use the '$1' syntax to refer to capture groups in the source regular expression. Filesthat do not match the source regular expression will be copied with the original name.

rename(sourceRegEx, replaceWith)

Renames files based on a regular expression. SeeCopyProcessingSpec.rename(java.lang.String, java.lang.String).

rename(renamer)

Renames a source file. The function will be called with a single parameter, the name of the file.The function should return a new target name. The function may return null,in which case the original name will be used.

webInf(configureClosure)

Adds some content to theWEB-INF directory for this WAR archive.

webInf(configureAction)

Adds some content to theWEB-INF directory for this WAR archive.

with(sourceSpecs)

Adds the given specs as a child of this spec.

Script blocks

No script blocks

Property details

Property<String>archiveAppendix

The appendix part of the archive name, if any.

Default withwar plugin:
""

Property<String>archiveBaseName

The base name of the archive.

Default withwar plugin:
project.archivesBaseName

Property<String>archiveClassifier

The classifier part of the archive name, if any.

Default withwar plugin:
""

Property<String>archiveExtension

The extension part of the archive name.

Provider<RegularFile>archiveFile

TheRegularFile where the archive is constructed.The path is simply thedestinationDirectory plus thearchiveFileName.

Default withwar plugin:
${destinationDirectory}/${archiveFileName}

Property<String>archiveFileName

The archive name. If the name has not been explicitly set, the pattern for the name is:[archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]

Default withwar plugin:
${archiveBaseName}-${archiveAppendix}-${archiveVersion}-${archiveClassifier}.${archiveExtension}

Property<String>archiveVersion

The version part of the archive name.

Default withwar plugin:
project.version

booleancaseSensitive

Specifies whether case-sensitive pattern matching should be used.

Default withwar plugin:
true

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 intheWEB-INF/classes directory.

Default withwar plugin:
project.sourceSets.main.runtimeClasspath - project.configurations.providedRuntime

DirectoryPropertydestinationDirectory

The directory where the archive will be placed.

Default withwar plugin:
project.distsDir

Property for querying and configuring directory access permissions.If the property has no value set, that means that existing permissions are preserved.It is dependent on the copy action implementation whether these permissions will actually be applied.For details seeConfigurableFilePermissions.

Default withwar plugin:
null

DuplicatesStrategyduplicatesStrategy

The strategy to use when trying to copy more than one file to the same destination.

The value can be set with a case insensitive string of the enum value (e.g.'exclude' forDuplicatesStrategy.EXCLUDE).

This strategy can be overridden for individual files by usingCopySpec.eachFile(org.gradle.api.Action) orCopySpec.filesMatching(java.lang.String, org.gradle.api.Action).

Default withwar plugin:
DuplicatesStrategy.INHERIT

ZipEntryCompressionentryCompression

The compression level of the entries of the archive. If set toZipEntryCompression.DEFLATED (the default), each entry iscompressed using the DEFLATE algorithm. If set toZipEntryCompression.STORED the entries of the archive are left uncompressed.

Default:
ZipEntryCompression.DEFLATED

Set<String>excludes

The set of exclude patterns.

Default withwar plugin:
[]

Property for querying and configuring file access permissions.If the property has no value set, that means that existing permissions are preserved.It is dependent on the copy action implementation whether these permissions will actually be applied.For details seeConfigurableFilePermissions.

Default withwar plugin:
null

booleanincludeEmptyDirs

Tells if empty target directories will be included in the copy.

Default withwar plugin:
true

Set<String>includes

The set of include patterns.

Default withwar plugin:
[]

Manifestmanifest

The manifest for this JAR archive.

StringmetadataCharset

The character set used to encode JAR metadata like file names.Defaults to UTF-8.You can change this property but it is not recommended as JVMs expect JAR metadata to be encoded using UTF-8

Default:
UTF-8

booleanpreserveFileTimestamps

Specifies whether file timestamps should be preserved in the archive.

Iffalse this ensures that archive entries have the same time for builds between different machines, Java versions and operating systems.

Default withwar plugin:
true

booleanreproducibleFileOrder

Specifies whether to enforce a reproducible file order when reading files from directories.

Gradle will then walk the directories on disk which are part of this archive in a reproducible orderindependent of file systems and operating systems.This helps Gradle reliably produce byte-for-byte reproducible archives.

Default withwar plugin:
false

FileCollectionsource (read-only)

The source files for this task.

FilewebXml

Theweb.xml file to include in the WAR archive. Whennull, noweb.xml file is included in the WAR.

Default withwar plugin:
null

booleanzip64

Whether the zip can contain more than 65535 files and/or support files greater than 4GB in size.

The standard zip format has hard limits on file size and count.TheZip64 format extensionpractically removes these limits and is therefore required for building large zips.

However, not all Zip readers support the Zip64 extensions.Notably, theZipInputStream JDK class does not support Zip64 for versions earlier than Java 7.This means you should not enable this property if you are building JARs to be used with Java 6 and earlier runtimes.

Default:
false

Method details

voidclasspath(Object... classpath)

Adds files to the classpath to include in the WAR archive.

AbstractCopyTaskeachFile(Closure closure)

Adds an action to be applied to each file as it about to be copied into its destination. The given closure iscalled with aFileCopyDetails as its parameter. Actions are executed in the orderadded, and are inherited from the parent spec.

AbstractCopyTaskeachFile(Action<? superFileCopyDetails> action)

Adds an action to be applied to each file as it is about to be copied into its destination. The action can changethe destination path of the file, filter the contents of the file, or exclude the file from the result entirely.Actions are executed in the order added, and are inherited from the parent spec.

AbstractCopyTaskexclude(Closure excludeSpec)

Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed aFileTreeElement as its parameter. The closure should return true or false. Example:

copySpec {  from'source'  into'destination'//an example of excluding files from certain configuration:  exclude { it.file in configurations.someConf.files }}

If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.

AbstractCopyTaskexclude(Iterable<String> excludes)

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.

AbstractCopyTaskexclude(String... excludes)

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.

Adds an exclude spec. This method may be called multiple times to append new specs.If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not matchany exclude pattern to be processed.

AbstractCopyTaskexpand(Map<String, ?> properties)

Expands property references in each file as it is copied. More specifically, each file is transformed usingGroovy'sSimpleTemplateEngine. This means you can use simple property references, such as$property or${property} in the file. You can also include arbitrary Groovy code in thefile, such as${version ?: 'unknown'} or${classpath*.name.join(' ')}

Note that all escape sequences (\n,\t,\\, etc) are converted to the symbolsthey represent, so, for example,\n becomes newline. If this is undesirable thenContentFilterable.expand(java.util.Map, org.gradle.api.Action)should be used to disable this behavior.

AbstractCopyTaskexpand(Map<String, ?> properties,Action<? superExpandDetails> action)

Expands property references in each file as it is copied. More specifically, each file is transformed usingGroovy'sSimpleTemplateEngine. This means you can use simple property references, such as$property or${property} in the file. You can also include arbitrary Groovy code in thefile, such as${version ?: 'unknown'} or${classpath*.name.join(' ')}. The templateengine can be configured with the provided action.

Note that by default all escape sequences (\n,\t,\\, etc) are converted to the symbolsthey represent, so, for example,\n becomes newline. This behavior is controlled byExpandDetails.getEscapeBackslash() property. It should be set totrue to disable escape sequencesconversion:

 expand(one:'1', two:2) {     escapeBackslash = true }

AbstractCopyTaskfilesMatching(Iterable<String> patterns,Action<? superFileCopyDetails> action)

Configure theFileCopyDetails for each file whose path matches any of the specified Ant-style patterns.This is equivalent to using eachFile() and selectively applying a configuration based on the file's path.

AbstractCopyTaskfilesMatching(String pattern,Action<? superFileCopyDetails> action)

Configure theFileCopyDetails for each file whose path matches the specified Ant-style pattern.This is equivalent to using eachFile() and selectively applying a configuration based on the file's path.

AbstractCopyTaskfilesNotMatching(Iterable<String> patterns,Action<? superFileCopyDetails> action)

Configure theFileCopyDetails for each file whose path does not match any of the specifiedAnt-style patterns. This is equivalent to using eachFile() and selectively applying a configuration based on thefile's path.

AbstractCopyTaskfilesNotMatching(String pattern,Action<? superFileCopyDetails> action)

Configure theFileCopyDetails for each file whose path does not match the specifiedAnt-style pattern. This is equivalent to using eachFile() and selectively applying a configuration based on thefile's path.

AbstractCopyTaskfilter(Closure closure)

Adds a content filter based on the provided closure. The Closure will be called with each line (stripped of lineendings) and should return a String to replace the line ornull to remove the line. If every line isremoved, the result will be an empty file, not an absent one.

AbstractCopyTaskfilter(Class<? extendsFilterReader> filterType)

Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to thefilter chain. Each filter should implementjava.io.FilterReader. Includeorg.apache.tools.ant.filters.* for access to all the standard Ant filters.

Examples:

   filter(StripJavaComments)   filter(com.mycompany.project.CustomFilter)

AbstractCopyTaskfilter(Map<String, ?> properties,Class<? extendsFilterReader> filterType)

Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to thefilter chain. Each filter should implementjava.io.FilterReader. Includeorg.apache.tools.ant.filters.* for access to all the standard Ant filters.

Filter properties may be specified using groovy map syntax.

Examples:

   filter(HeadFilter, lines:25, skip:2)   filter(ReplaceTokens, tokens:[copyright:'2009', version:'2.3.1'])

Adds a content filter based on the provided transformer. The Closure will be called with each line (stripped of lineendings) and should return a String to replace the line ornull to remove the line. If every line isremoved, the result will be an empty file, not an absent one.

AbstractCopyTaskfrom(Object sourcePath,Closure c)

Specifies the source files or directories for a copy and creates a childCopySourceSpec. The given sourcepath is evaluated as perProject.files(java.lang.Object[]) .

AbstractCopyTaskfrom(Object sourcePath,Action<? superCopySpec> configureAction)

Specifies the source files or directories for a copy and creates a childCopySpec. The given sourcepath is evaluated as perProject.files(java.lang.Object[]) .

AbstractCopyTaskfrom(Object... sourcePaths)

Specifies source files or directories for a copy. The given paths are evaluated as perProject.files(java.lang.Object[]).

AbstractCopyTaskinclude(Closure includeSpec)

Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed aFileTreeElement as its parameter.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included.

AbstractCopyTaskinclude(Iterable<String> includes)

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed.

AbstractCopyTaskinclude(String... includes)

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiplepatterns may be specified in a single call.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns to be processed.

Adds an include spec. This method may be called multiple times to append new specs.If includes are not provided, then all files in this container will be included. If includes are provided, then afile must match at least one of the include patterns or specs to be included.

Specifies the destination directory *inside* the archive for the files.The destination is evaluated as perProject.file(java.lang.Object).Don't mix it up withAbstractArchiveTask.getDestinationDirectory() which specifies the output directory for the archive.

AbstractArchiveTaskinto(Object destPath,Closure configureClosure)

Creates and configures a childCopySpec with a destination directory *inside* the archive for the files.The destination is evaluated as perProject.file(java.lang.Object).Don't mix it up withAbstractArchiveTask.getDestinationDirectory() which specifies the output directory for the archive.

CopySpecinto(Object destPath,Action<? superCopySpec> copySpec)

Creates and configures a childCopySpec with a destination directory *inside* the archive for the files.The destination is evaluated as perProject.file(java.lang.Object).Don't mix it up withAbstractArchiveTask.getDestinationDirectory() which specifies the output directory for the archive.

Jarmanifest(Closure<?> configureClosure)

Configures the manifest for this JAR archive.

The given closure is executed to configure the manifest. TheManifest is passed to the closure as its delegate.

Jarmanifest(Action<? superManifest> configureAction)

Configures the manifest for this JAR archive.

The given action is executed to configure the manifest.

CopySpecmetaInf(Closure<?> configureClosure)

Adds content to this JAR archive's META-INF directory.

The given closure is executed to configure aCopySpec. TheCopySpec is passed to the closure as its delegate.

CopySpecmetaInf(Action<? superCopySpec> configureAction)

Adds content to this JAR archive's META-INF directory.

The given action is executed to configure aCopySpec.

AbstractCopyTaskrename(Closure closure)

Renames a source file. The closure will be called with a single parameter, the name of the file.The closure should return a String object with a new target name. The closure may return null,in which case the original name will be used.

AbstractCopyTaskrename(String sourceRegEx,String replaceWith)

Renames files based on a regular expression. Uses java.util.regex type of regular expressions. Note that thereplace string should use the '$1' syntax to refer to capture groups in the source regular expression. Filesthat do not match the source regular expression will be copied with the original name.

Example:

rename'(.*)_OEM_BLUE_(.*)','$1$2'

would map the file 'style_OEM_BLUE_.css' to 'style.css'

AbstractCopyTaskrename(Pattern sourceRegEx,String replaceWith)

Renames files based on a regular expression. SeeCopyProcessingSpec.rename(java.lang.String, java.lang.String).

Renames a source file. The function will be called with a single parameter, the name of the file.The function should return a new target name. The function may return null,in which case the original name will be used.

CopySpecwebInf(Closure configureClosure)

Adds some content to theWEB-INF directory for this WAR archive.

The given closure is executed to configure aCopySpec. TheCopySpec is passed to the closure as its delegate.

CopySpecwebInf(Action<? superCopySpec> configureAction)

Adds some content to theWEB-INF directory for this WAR archive.

The given action is executed to configure aCopySpec.

CopySpecwith(CopySpec... sourceSpecs)

Adds the given specs as a child of this spec.

def contentSpec = copySpec {  from("content") {    include"**/*.txt"  }}task copy(type: Copy) {  into"$buildDir/copy"  with contentSpec}
©Gradle Inc. All rights reserved.
gradle
Careers |Privacy |Terms of Service |Contact

[8]ページ先頭

©2009-2025 Movatter.jp