java.lang.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
, Configurable<Task>
Jar
@DisableCachingByDefault(because="Not worth caching") public class Zip extends AbstractArchiveTask
Task.Namer
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
ZIP_EXTENSION |
TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
Constructor | Description |
---|---|
Zip() |
Modifier and Type | Method | 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.
|
java.lang.String |
getMetadataCharset() |
The character set used to encode ZIP metadata like file names.
|
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 |
setMetadataCharset(java.lang.String metadataCharset) |
The character set used to encode ZIP metadata like file names.
|
void |
setZip64(boolean allowZip64) |
Enables building zips with more than 65535 files or bigger than 4GB.
|
createCopyActionExecuter, getAppendix, getArchiveAppendix, getArchiveBaseName, getArchiveClassifier, getArchiveExtension, getArchiveFile, getArchiveFileName, getArchiveName, getArchivePath, getArchiveVersion, getBaseName, getClassifier, getDestinationDir, getDestinationDirectory, getExtension, getVersion, into, into, into, isPreserveFileTimestamps, isReproducibleFileOrder, setAppendix, setArchiveName, setBaseName, setClassifier, setDestinationDir, setExtension, setPreserveFileTimestamps, setReproducibleFileOrder, setVersion
copy, createRootSpec, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, expand, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirectoryFileTreeFactory, getDirMode, getDocumentationRegistry, getDuplicatesStrategy, getExcludes, getFileLookup, getFileMode, getFileResolver, getFileSystem, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getObjectFactory, getRootSpec, getSource, include, include, include, include, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with
conventionMapping, conventionMapping, getConventionMapping
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
appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
doNotTrackState, getConvention, notCompatibleWithConfigurationCache
public static final java.lang.String ZIP_EXTENSION
@Internal protected org.gradle.api.internal.file.copy.ZipCompressor getCompressor()
protected org.gradle.api.internal.file.copy.CopyAction createCopyAction()
createCopyAction
in class AbstractCopyTask
@Input public ZipEntryCompression getEntryCompression()
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.public void setEntryCompression(ZipEntryCompression entryCompression)
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.entryCompression
- STORED
or DEFLATED
public void setZip64(boolean allowZip64)
isZip64()
@Input public boolean isZip64()
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.
@Nullable @Optional @Input public java.lang.String getMetadataCharset()
public void setMetadataCharset(java.lang.String metadataCharset)
metadataCharset
- the character set used to encode ZIP metadata like file names