org.gradle.api.tasks.bundling

Class Zip

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

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>

public class Zip
extends AbstractArchiveTask

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	Zip.ZipCopyActionImpl Deprecated.

Nested classes/interfaces inherited from interface org.gradle.api.Task

Task.Namer

Field Summary

Fields

Modifier and Type	Field and Description
static String	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

Constructor and Description
Zip()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.gradle.api.internal.file.copy.CopyAction	createCopyAction()
protected org.gradle.api.internal.file.copy.ZipCompressor	getCompressor()
ZipEntryCompression	getEntryCompression() Returns the compression level of the entries of the archive.
boolean	isZip64() Whether the zip can contain more than 65535 files and/or support files greater than 4GB in size.
void	setEntryCompression(ZipEntryCompression entryCompression) Sets the compression level of the entries of the archive.
void	setZip64(boolean allowZip64) Enables building zips with more than 65535 files or bigger than 4GB.

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

getAppendix, getArchiveName, getArchivePath, getBaseName, getClassifier, getDestinationDir, getExtension, getVersion, into, into, setAppendix, setArchiveName, setBaseName, setClassifier, setDestinationDir, setExtension, setVersion

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

copy, createRootSpec, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, filesMatching, filesNotMatching, filter, filter, filter, from, from, getDirMode, getDuplicatesStrategy, getExcludes, getFileLookup, getFileMode, getFileResolver, getFileSystem, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getRootSpec, getSource, include, include, include, include, isCaseSensitive, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setIncludeEmptyDirs, setIncludes, with

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

conventionMapping, conventionMapping, getConventionMapping

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

addValidator, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doLast, doLast, execute, executeWithoutThrowingTaskFailure, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getInputs, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, leftShift, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setMustRunAfter, setName, setOnlyIf, setOnlyIf, setProject, setProperty, setShouldRunAfter, shouldRunAfter, toString

Methods inherited from class java.lang.Object

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

Field Detail

ZIP_EXTENSION

public static final String ZIP_EXTENSION

See Also:

Constant Field Values

Constructor Detail

Zip

public Zip()

Method Detail

getCompressor

protected org.gradle.api.internal.file.copy.ZipCompressor getCompressor()

createCopyAction

protected org.gradle.api.internal.file.copy.CopyAction createCopyAction()

Specified by:

createCopyAction in class AbstractCopyTask

getEntryCompression

public ZipEntryCompression getEntryCompression()

Returns 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.

Returns:

the compression level of the archive contents.

setEntryCompression

public void setEntryCompression(ZipEntryCompression entryCompression)

Sets 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.

Parameters:

entryCompression - STORED or DEFLATED

setZip64

@Incubating
public void setZip64(boolean allowZip64)

Enables building zips with more than 65535 files or bigger than 4GB.

See Also:

isZip64()

isZip64

@Incubating
public boolean isZip64()

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.