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>@DisableCachingByDefault(because="Abstract super-class, not to be instantiated directly") public abstract class AbstractArchiveTask extends AbstractCopyTask
AbstractArchiveTask is the base class for all archive tasks.Task.NamerTASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE| Constructor | Description |
|---|---|
AbstractArchiveTask() |
| Modifier and Type | Method | Description |
|---|---|---|
protected org.gradle.api.internal.file.copy.CopyActionExecuter |
createCopyActionExecuter() |
|
java.lang.String |
getAppendix() |
Deprecated.
|
Property<java.lang.String> |
getArchiveAppendix() |
Returns the appendix part of the archive name, if any.
|
Property<java.lang.String> |
getArchiveBaseName() |
Returns the base name of the archive.
|
Property<java.lang.String> |
getArchiveClassifier() |
Returns the classifier part of the archive name, if any.
|
Property<java.lang.String> |
getArchiveExtension() |
Returns the extension part of the archive name.
|
Provider<RegularFile> |
getArchiveFile() |
The
RegularFile where the archive is constructed. |
Property<java.lang.String> |
getArchiveFileName() |
Returns the archive name.
|
java.lang.String |
getArchiveName() |
Deprecated.
|
java.io.File |
getArchivePath() |
Deprecated.
Use
getArchiveFile() |
Property<java.lang.String> |
getArchiveVersion() |
Returns the version part of the archive name.
|
java.lang.String |
getBaseName() |
Deprecated.
|
java.lang.String |
getClassifier() |
Deprecated.
|
java.io.File |
getDestinationDir() |
Deprecated.
|
DirectoryProperty |
getDestinationDirectory() |
The directory where the archive will be placed.
|
java.lang.String |
getExtension() |
Deprecated.
|
java.lang.String |
getVersion() |
Deprecated.
|
AbstractArchiveTask |
into(java.lang.Object destPath) |
Specifies the destination directory *inside* the archive for the files.
|
AbstractArchiveTask |
into(java.lang.Object destPath,
Closure configureClosure) |
Creates and configures a child
CopySpec with a destination directory *inside* the archive for the files. |
CopySpec |
into(java.lang.Object destPath,
Action<? super CopySpec> copySpec) |
Creates and configures a child
CopySpec with a destination directory *inside* the archive for the files. |
boolean |
isPreserveFileTimestamps() |
Specifies whether file timestamps should be preserved in the archive.
|
boolean |
isReproducibleFileOrder() |
Specifies whether to enforce a reproducible file order when reading files from directories.
|
void |
setAppendix(java.lang.String appendix) |
Deprecated.
|
void |
setArchiveName(java.lang.String name) |
Deprecated.
|
void |
setBaseName(java.lang.String baseName) |
Deprecated.
|
void |
setClassifier(java.lang.String classifier) |
Deprecated.
|
void |
setDestinationDir(java.io.File destinationDir) |
Deprecated.
|
void |
setExtension(java.lang.String extension) |
Deprecated.
|
void |
setPreserveFileTimestamps(boolean preserveFileTimestamps) |
Specifies whether file timestamps should be preserved in the archive.
|
void |
setReproducibleFileOrder(boolean reproducibleFileOrder) |
Specifies whether to enforce a reproducible file order when reading files from directories.
|
void |
setVersion(java.lang.String version) |
Deprecated.
|
copy, createCopyAction, 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, withconventionMapping, conventionMapping, getConventionMappingcompareTo, 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, usesServiceappendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjectsclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdoNotTrackState, getConvention, notCompatibleWithConfigurationCache@Deprecated @ReplacedBy("archiveFileName") public java.lang.String getArchiveName()
[archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]@Deprecated public void setArchiveName(java.lang.String name)
name - the archive name.@Internal("Represented as part of archiveFile") public Property<java.lang.String> getArchiveFileName()
[archiveBaseName]-[archiveAppendix]-[archiveVersion]-[archiveClassifier].[archiveExtension]@Deprecated @ReplacedBy("archiveFile") public java.io.File getArchivePath()
getArchiveFile()destinationDirectory plus the archiveFileName.@OutputFile public Provider<RegularFile> getArchiveFile()
RegularFile where the archive is constructed.
The path is simply the destinationDirectory plus the archiveFileName.RegularFile object with the path to the archive@Deprecated @ReplacedBy("destinationDirectory") public java.io.File getDestinationDir()
@Deprecated public void setDestinationDir(java.io.File destinationDir)
@Internal("Represented by the archiveFile") public DirectoryProperty getDestinationDirectory()
@Nullable @Deprecated @ReplacedBy("archiveBaseName") public java.lang.String getBaseName()
@Deprecated
public void setBaseName(@Nullable
java.lang.String baseName)
@Internal("Represented as part of archiveFile") public Property<java.lang.String> getArchiveBaseName()
@Nullable @Deprecated @ReplacedBy("archiveAppendix") public java.lang.String getAppendix()
@Deprecated
public void setAppendix(@Nullable
java.lang.String appendix)
@Internal("Represented as part of archiveFile") public Property<java.lang.String> getArchiveAppendix()
@Nullable @Deprecated @ReplacedBy("archiveVersion") public java.lang.String getVersion()
@Deprecated
public void setVersion(@Nullable
java.lang.String version)
@Internal("Represented as part of archiveFile") public Property<java.lang.String> getArchiveVersion()
@Nullable @Deprecated @ReplacedBy("archiveExtension") public java.lang.String getExtension()
@Deprecated
public void setExtension(@Nullable
java.lang.String extension)
@Internal("Represented as part of archiveFile") public Property<java.lang.String> getArchiveExtension()
@Nullable @Deprecated @ReplacedBy("archiveClassifier") public java.lang.String getClassifier()
@Deprecated
public void setClassifier(@Nullable
java.lang.String classifier)
@Internal("Represented as part of archiveFile") public Property<java.lang.String> getArchiveClassifier()
public AbstractArchiveTask into(java.lang.Object destPath)
Project.file(Object).
Don't mix it up with getDestinationDirectory() which specifies the output directory for the archive.into in interface CopyProcessingSpecinto in interface CopySpecinto in class AbstractCopyTaskdestPath - destination directory *inside* the archive for the filespublic AbstractArchiveTask into(java.lang.Object destPath, Closure configureClosure)
CopySpec with a destination directory *inside* the archive for the files.
The destination is evaluated as per Project.file(Object).
Don't mix it up with getDestinationDirectory() which specifies the output directory for the archive.into in interface CopySpecinto in class AbstractCopyTaskdestPath - destination directory *inside* the archive for the filesconfigureClosure - The closure to use to configure the child CopySpec.public CopySpec into(java.lang.Object destPath, Action<? super CopySpec> copySpec)
CopySpec with a destination directory *inside* the archive for the files.
The destination is evaluated as per Project.file(Object).
Don't mix it up with getDestinationDirectory() which specifies the output directory for the archive.into in interface CopySpecinto in class AbstractCopyTaskdestPath - destination directory *inside* the archive for the filescopySpec - The closure to use to configure the child CopySpec.@Input public boolean isPreserveFileTimestamps()
If false this ensures that archive entries have the same time for builds between different machines, Java versions and operating systems.
true if file timestamps should be preserved for archive entriespublic void setPreserveFileTimestamps(boolean preserveFileTimestamps)
If false this ensures that archive entries have the same time for builds between different machines, Java versions and operating systems.
preserveFileTimestamps - true if file timestamps should be preserved for archive entries@Input public boolean isReproducibleFileOrder()
Gradle will then walk the directories on disk which are part of this archive in a reproducible order independent of file systems and operating systems. This helps Gradle reliably produce byte-for-byte reproducible archives.
true if the files should read from disk in a reproducible order.public void setReproducibleFileOrder(boolean reproducibleFileOrder)
Gradle will then walk the directories on disk which are part of this archive in a reproducible order independent of file systems and operating systems. This helps Gradle reliably produce byte-for-byte reproducible archives.
reproducibleFileOrder - true if the files should read from disk in a reproducible order.protected org.gradle.api.internal.file.copy.CopyActionExecuter createCopyActionExecuter()
createCopyActionExecuter in class AbstractCopyTask