# Zip

API Documentation: | `Zip`

Known Subtypes: |
`Jar`

Assembles a ZIP archive. The default is to compress the contents of the zip.

### Properties

Property | Description
`appendix` | The appendix part of the archive name, if any.
`archiveName` | The archive name. If the name has not been explicitly set, the pattern for the name is: `[baseName]-[appendix]-[version]-[classifier].[extension]`
`archivePath` | The path where the archive is constructed. The path is simply the `destinationDir` plus the `archiveName`.
`baseName` | The base name of the archive.
`caseSensitive` | Specifies whether case-sensitive pattern matching should be used.
`classifier` | The classifier part of the archive name, if any.
`destinationDir` | The directory where the archive is generated into.
`dirMode` | The Unix permissions to use for the target directories. `null` means that existing permissions are preserved. It is dependent on the copy action implementation whether these permissions will actually be applied.
`duplicatesStrategy` | The strategy to use when trying to copy more than one file to the same destination.
`encoding` | The encoding to use for filenames and the file comment of the archive.
`entryCompression` | The compression level of the entries of the archive. If set to `ZipEntryCompression.DEFLATED` (the default), each entry is compressed using the DEFLATE algorithm. If set to `ZipEntryCompression.STORED` the entries of the archive are left uncompressed.
`excludes` | The set of exclude patterns.
`extension` | The extension part of the archive name.
`fileMode` | The Unix permissions to use for the target files. `null` means that existing permissions are preserved. It is dependent on the copy action implementation whether these permissions will actually be applied.
`includeEmptyDirs` | Tells if empty target directories will be included in the copy.
`includes` | The set of include patterns.
`source` | The source files for this task.
`version` | The version part of the archive name, if any.
`zip64` | Incubating Whether the zip can contain more than 65535 files and/or support files greater than 4GB in size.

### Methods

Method | Description
`eachFile(closure)` | Adds an action to be applied to each file as it about to be copied into its destination. The given closure is called with a `FileCopyDetails` as its parameter. Actions are executed in the order added, 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 change the 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 a `FileTreeElement` 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 multiple patterns 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 match any 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 multiple patterns 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 match any 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 match any exclude pattern to be processed.
`expand(properties)` | Expands property references in each file as it is copied. More specifically, each file is transformed using Groovy's `SimpleTemplateEngine`. This means you can use simple property references, such as `$property` or `${property}` in the file. You can also include arbitrary Groovy code in the file, such as `${version ?: 'unknown'}` or `${classpath*.name.join(' ')}`
`filesMatching(pattern, action)` | Configure the `FileCopyDetails` 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(pattern, action)` | Configure the `FileCopyDetails` for each file whose path does not match the specified Ant-style pattern. This is equivalent to using eachFile() and selectively applying a configuration based on the file's path.
`filter(closure)` | Adds a content filter based on the provided closure. The Closure will be called with each line (stripped of line endings) and should return a String to replace the line or `null` to remove the line. If every line is removed, 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 the filter chain. Each filter should implement `java.io.FilterReader`. Include `org.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 the filter chain. Each filter should implement `java.io.FilterReader`. Include `org.apache.tools.ant.filters.*` for access to all the standard Ant filters.
`from(sourcePath, c)` | Specifies the source files or directories for a copy and creates a child `CopySourceSpec`. The given source path is evaluated as per `Project.files()` .
`from(sourcePaths)` | Specifies source files or directories for a copy. The given paths are evaluated as per `Project.files()`.
`include(includeSpec)` | Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a `FileTreeElement` as its parameter. If includes are not provided, then all files in this container will be included. If includes are provided, then a file 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 multiple patterns 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 a file 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 multiple patterns 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 a file 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 a file 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 per `Project.file()`. Don't mix it up with `AbstractArchiveTask.getDestinationDir()` which specifies the output directory for the archive.
`into(destPath, configureClosure)` | Creates and configures a child `CopySpec` with a destination directory *inside* the archive for the files. The destination is evaluated as per `Project.file()`. Don't mix it up with `AbstractArchiveTask.getDestinationDir()` which specifies the output directory for the archive.
`rename(closure)` | Renames a source file to a different relative location under the target directory. 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 the replace string should use the '$1' syntax to refer to capture groups in the source regular expression. Files that do not match the source regular expression will be copied with the original name.
`rename(sourceRegEx, replaceWith)` | Renames files based on a regular expression. See `CopyProcessingSpec.rename()`.
`with(sourceSpecs)` | Adds the given specs as a child of this spec.

### Script blocks

No script blocks

### Property details

#### `String` `appendix`

The appendix part of the archive name, if any.

Default with `java` plugin:
  `null`

#### `String` `archiveName`

The archive name. If the name has not been explicitly set, the pattern for the name is: `[baseName]-[appendix]-[version]-[classifier].[extension]`

Default with `java` plugin:
  ``${baseName}`-`${appendix}`-`${version}`-`${classifier}`.`${extension}``

#### `File` `archivePath` (read-only)

The path where the archive is constructed. The path is simply the `destinationDir` plus the `archiveName`.

Default with `java` plugin:
  ``${destinationDir}`/`${archiveName}``

#### `String` `baseName`

The base name of the archive.

Default with `java` plugin:
  `project.archivesBaseName`

#### `boolean` `caseSensitive`

Specifies whether case-sensitive pattern matching should be used.

Default with `java` plugin:
  `true`

#### `String` `classifier`

The classifier part of the archive name, if any.

Default with `java` plugin:
  `null`

#### `File` `destinationDir`

The directory where the archive is generated into.

Default with `java` plugin:
  `project.distsDir`

#### `Integer` `dirMode`

The Unix permissions to use for the target directories. `null` means that existing permissions are preserved. It is dependent on the copy action implementation whether these permissions will actually be applied.

Default with `java` plugin:
  `null`

#### `DuplicatesStrategy` `duplicatesStrategy`

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'` for `DuplicatesStrategy.EXCLUDE`).

This strategy can be overridden for individual files by using `CopySpec.eachFile()` or `CopySpec.filesMatching()`.

Default with `java` plugin:
  `null`

#### `String` `encoding`

The encoding to use for filenames and the file comment of the archive.

Default:
  Platform default encoding

#### `ZipEntryCompression` `entryCompression`

The compression level of the entries of the archive. If set to `ZipEntryCompression.DEFLATED` (the default), each entry is compressed using the DEFLATE algorithm. If set to `ZipEntryCompression.STORED` the entries of the archive are left uncompressed.

Default:
  `ZipEntryCompression.DEFLATED`

#### ``Set`<`String`>` `excludes`

The set of exclude patterns.

Default with `java` plugin:
  `[]`

#### `String` `extension`

The extension part of the archive name.

#### `Integer` `fileMode`

The Unix permissions to use for the target files. `null` means that existing permissions are preserved. It is dependent on the copy action implementation whether these permissions will actually be applied.

Default with `java` plugin:
  `null`

#### `boolean` `includeEmptyDirs`

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

Default with `java` plugin:
  `true`

#### ``Set`<`String`>` `includes`

The set of include patterns.

Default with `java` plugin:
  `[]`

#### `FileCollection` `source` (read-only)

The source files for this task.

Default with `java` plugin:
  `[]`

#### `String` `version`

The version part of the archive name, if any.

Default with `java` plugin:
  `project.version`

#### `boolean` `zip64`

Note: This property is incubating and may change in a future version of Gradle.

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. The Zip64 format extension practically removes these limits and is therefore required for building large zips.

However, not all Zip readers support the Zip64 extensions. Notably, the `ZipInputStream` 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

#### `AbstractCopyTask` `eachFile`(`Closure` closure)

Adds an action to be applied to each file as it about to be copied into its destination. The given closure is called with a `FileCopyDetails` as its parameter. Actions are executed in the order added, and are inherited from the parent spec.

#### `AbstractCopyTask` `eachFile`(``Action`<? super `FileCopyDetails`>` action)

Adds an action to be applied to each file as it is about to be copied into its destination. The action can change the 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.

#### `AbstractCopyTask` `exclude`(`Closure` excludeSpec)

Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a `FileTreeElement` 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 match any exclude pattern to be processed.

#### `AbstractCopyTask` `exclude`(``Iterable`<`String`>` excludes)

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns 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 match any exclude pattern to be processed.

#### `AbstractCopyTask` `exclude`(``String`...` excludes)

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns 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 match any exclude pattern to be processed.

#### `AbstractCopyTask` `exclude`(``Spec`<`FileTreeElement`>` 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 match any exclude pattern to be processed.

#### `AbstractCopyTask` `expand`(``Map`<`String`, ?>` properties)

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

#### `AbstractCopyTask` `filesMatching`(`String` pattern, ``Action`<? super `FileCopyDetails`>` action)

Configure the `FileCopyDetails` 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.

#### `AbstractCopyTask` `filesNotMatching`(`String` pattern, ``Action`<? super `FileCopyDetails`>` action)

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

#### `AbstractCopyTask` `filter`(`Closure` closure)

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

#### `AbstractCopyTask` `filter`(``Class`<? extends `FilterReader`>` filterType)

Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to the filter chain. Each filter should implement `java.io.FilterReader`. Include `org.apache.tools.ant.filters.*` for access to all the standard Ant filters.

Examples:

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

#### `AbstractCopyTask` `filter`(``Map`<`String`, ?>` properties, ``Class`<? extends `FilterReader`>` filterType)

Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to the filter chain. Each filter should implement `java.io.FilterReader`. Include `org.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'])

#### `AbstractCopyTask` `from`(`Object` sourcePath, `Closure` c)

Specifies the source files or directories for a copy and creates a child `CopySourceSpec`. The given source path is evaluated as per `Project.files()` .

#### `AbstractCopyTask` `from`(``Object`...` sourcePaths)

Specifies source files or directories for a copy. The given paths are evaluated as per `Project.files()`.

#### `AbstractCopyTask` `include`(`Closure` includeSpec)

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

#### `AbstractCopyTask` `include`(``Iterable`<`String`>` includes)

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns 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 a file must match at least one of the include patterns to be processed.

#### `AbstractCopyTask` `include`(``String`...` includes)

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns 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 a file must match at least one of the include patterns to be processed.

#### `AbstractCopyTask` `include`(``Spec`<`FileTreeElement`>` 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 a file must match at least one of the include patterns or specs to be included.

#### `AbstractArchiveTask` `into`(`Object` destPath)

Specifies the destination directory *inside* the archive for the files. The destination is evaluated as per `Project.file()`. Don't mix it up with `AbstractArchiveTask.getDestinationDir()` which specifies the output directory for the archive.

#### `AbstractArchiveTask` `into`(`Object` destPath, `Closure` configureClosure)

Creates and configures a child `CopySpec` with a destination directory *inside* the archive for the files. The destination is evaluated as per `Project.file()`. Don't mix it up with `AbstractArchiveTask.getDestinationDir()` which specifies the output directory for the archive.

#### `AbstractCopyTask` `rename`(`Closure` closure)

Renames a source file to a different relative location under the target directory. 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.

#### `AbstractCopyTask` `rename`(`String` sourceRegEx, `String` replaceWith)

Renames files based on a regular expression. Uses java.util.regex type of regular expressions. Note that the replace string should use the '$1' syntax to refer to capture groups in the source regular expression. Files that 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'

#### `AbstractCopyTask` `rename`(`Pattern` sourceRegEx, `String` replaceWith)

Renames files based on a regular expression. See `CopyProcessingSpec.rename()`.

#### `CopySpec` `with`(``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
    }