Package org.gradle.api.tasks.bundling
Class AbstractArchiveTask
- 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
-
- 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 abstract class AbstractArchiveTask extends AbstractCopyTask
AbstractArchiveTask
is the base class for all archive tasks.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.gradle.api.Task
Task.Namer
-
-
Field Summary
-
Fields inherited from interface org.gradle.api.Task
TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
-
-
Constructor Summary
Constructors Constructor Description AbstractArchiveTask()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected org.gradle.api.internal.file.copy.CopyActionExecuter
createCopyActionExecuter()
String
getAppendix()
Deprecated.Property<String>
getArchiveAppendix()
Returns the appendix part of the archive name, if any.Property<String>
getArchiveBaseName()
Returns the base name of the archive.Property<String>
getArchiveClassifier()
Returns the classifier part of the archive name, if any.Property<String>
getArchiveExtension()
Returns the extension part of the archive name.Provider<RegularFile>
getArchiveFile()
TheRegularFile
where the archive is constructed.Property<String>
getArchiveFileName()
Returns the archive name.String
getArchiveName()
Deprecated.File
getArchivePath()
Deprecated.UsegetArchiveFile()
Property<String>
getArchiveVersion()
Returns the version part of the archive name.String
getBaseName()
Deprecated.String
getClassifier()
Deprecated.File
getDestinationDir()
Deprecated.DirectoryProperty
getDestinationDirectory()
The directory where the archive will be placed.String
getExtension()
Deprecated.String
getVersion()
Deprecated.AbstractArchiveTask
into(Object destPath)
Specifies the destination directory *inside* the archive for the files.AbstractArchiveTask
into(Object destPath, Closure configureClosure)
Creates and configures a childCopySpec
with a destination directory *inside* the archive for the files.CopySpec
into(Object destPath, Action<? super CopySpec> copySpec)
Creates and configures a childCopySpec
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(String appendix)
Deprecated.void
setArchiveName(String name)
Deprecated.void
setBaseName(String baseName)
Deprecated.void
setClassifier(String classifier)
Deprecated.void
setDestinationDir(File destinationDir)
Deprecated.void
setExtension(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(String version)
Deprecated.-
Methods inherited from class org.gradle.api.tasks.AbstractCopyTask
copy, createCopyAction, createRootSpec, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirectoryFileTreeFactory, getDirMode, getDuplicatesStrategy, getExcludes, getFileLookup, getFileMode, getFileResolver, getFileSystem, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getRootSpec, getSource, include, include, include, include, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with
-
Methods inherited from class org.gradle.api.internal.ConventionTask
conventionMapping, conventionMapping, getConventionMapping
-
Methods inherited from class org.gradle.api.DefaultTask
newInputDirectory, newInputFile, newOutputDirectory, newOutputFile
-
Methods inherited from class org.gradle.api.internal.AbstractTask
appendParallelSafeAction, compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTaskIdentity, getTemporaryDir, getTemporaryDirFactory, getTimeout, hasProperty, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, replaceLogger, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString
-
-
-
-
Method Detail
-
getArchiveName
@Deprecated @Internal("Represented as part of archiveFile") public String getArchiveName()
Deprecated.Returns the archive name. If the name has not been explicitly set, the pattern for the name is:[baseName]-[appendix]-[version]-[classifier].[extension]
- Returns:
- the archive name.
-
setArchiveName
@Deprecated public void setArchiveName(String name)
Deprecated.Sets the archive name.- Parameters:
name
- the archive name.
-
getArchiveFileName
@Internal("Represented as part of archiveFile") public Property<String> getArchiveFileName()
Returns the archive name. If the name has not been explicitly set, the pattern for the name is:[baseName]-[appendix]-[version]-[classifier].[extension]
- Returns:
- the archive name.
- Since:
- 5.1
-
getArchivePath
@Deprecated @Internal("Represented as a part of the archiveFile") public File getArchivePath()
Deprecated.UsegetArchiveFile()
The path where the archive is constructed. The path is simply thedestinationDir
plus thearchiveName
.- Returns:
- a File object with the path to the archive
-
getArchiveFile
@OutputFile public Provider<RegularFile> getArchiveFile()
TheRegularFile
where the archive is constructed. The path is simply thedestinationDir
plus thearchiveName
.- Returns:
- a
RegularFile
object with the path to the archive - Since:
- 5.1
-
getDestinationDir
@Internal("Represented as part of archiveFile") @Deprecated public File getDestinationDir()
Deprecated.Returns the directory where the archive is generated into.- Returns:
- the directory
-
setDestinationDir
@Deprecated public void setDestinationDir(File destinationDir)
Deprecated.Sets the destination dir.
-
getDestinationDirectory
@Internal("Represented by the archiveFile") public DirectoryProperty getDestinationDirectory()
The directory where the archive will be placed.- Since:
- 5.1
-
getBaseName
@Nullable @Internal("Represented as part of archiveFile") @Deprecated public String getBaseName()
Deprecated.Returns the base name of the archive.- Returns:
- the base name. May be null.
-
setBaseName
@Deprecated public void setBaseName(@Nullable String baseName)
Deprecated.Sets the base name.
-
getArchiveBaseName
@Internal("Represented as part of archiveFile") public Property<String> getArchiveBaseName()
Returns the base name of the archive.- Returns:
- the base name. Internal property may be null.
- Since:
- 5.1
-
getAppendix
@Nullable @Internal("Represented as part of archiveFile") @Deprecated public String getAppendix()
Deprecated.Returns the appendix part of the archive name, if any.- Returns:
- the appendix. May be null
-
setAppendix
@Deprecated public void setAppendix(@Nullable String appendix)
Deprecated.Sets the appendix.
-
getArchiveAppendix
@Internal("Represented as part of archiveFile") public Property<String> getArchiveAppendix()
Returns the appendix part of the archive name, if any.- Returns:
- the appendix. May be null
- Since:
- 5.1
-
getVersion
@Nullable @Internal("Represented as part of archiveFile") @Deprecated public String getVersion()
Deprecated.Returns the version part of the archive name, if any.- Returns:
- the version. May be null.
-
setVersion
@Deprecated public void setVersion(@Nullable String version)
Deprecated.Sets the version.
-
getArchiveVersion
@Internal("Represented as part of archiveFile") public Property<String> getArchiveVersion()
Returns the version part of the archive name.- Returns:
- the version. Internal property may be null.
- Since:
- 5.1
-
getExtension
@Nullable @Internal("Represented as part of archiveFile") @Deprecated public String getExtension()
Deprecated.Returns the extension part of the archive name.
-
setExtension
@Deprecated public void setExtension(@Nullable String extension)
Deprecated.Sets the extension.
-
getArchiveExtension
@Internal("Represented as part of archiveFile") public Property<String> getArchiveExtension()
Returns the extension part of the archive name.- Since:
- 5.1
-
getClassifier
@Nullable @Internal("Represented as part of archiveFile") @Deprecated public String getClassifier()
Deprecated.Returns the classifier part of the archive name, if any.- Returns:
- The classifier. May be null.
-
setClassifier
@Deprecated public void setClassifier(@Nullable String classifier)
Deprecated.Sets the classifier.
-
getArchiveClassifier
@Internal("Represented as part of archiveFile") public Property<String> getArchiveClassifier()
Returns the classifier part of the archive name, if any.- Returns:
- The classifier. Internal property may be null.
- Since:
- 5.1
-
into
public AbstractArchiveTask into(Object destPath)
Specifies the destination directory *inside* the archive for the files. The destination is evaluated as perProject.file(Object)
. Don't mix it up withgetDestinationDirectory()
which specifies the output directory for the archive.- Specified by:
into
in interfaceCopyProcessingSpec
- Specified by:
into
in interfaceCopySpec
- Overrides:
into
in classAbstractCopyTask
- Parameters:
destPath
- destination directory *inside* the archive for the files- Returns:
- this
-
into
public AbstractArchiveTask into(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(Object)
. Don't mix it up withgetDestinationDirectory()
which specifies the output directory for the archive.- Specified by:
into
in interfaceCopySpec
- Overrides:
into
in classAbstractCopyTask
- Parameters:
destPath
- destination directory *inside* the archive for the filesconfigureClosure
- The closure to use to configure the childCopySpec
.- Returns:
- this
-
into
public CopySpec into(Object destPath, Action<? super CopySpec> copySpec)
Creates and configures a childCopySpec
with a destination directory *inside* the archive for the files. The destination is evaluated as perProject.file(Object)
. Don't mix it up withgetDestinationDirectory()
which specifies the output directory for the archive.- Specified by:
into
in interfaceCopySpec
- Overrides:
into
in classAbstractCopyTask
- Parameters:
destPath
- destination directory *inside* the archive for the filescopySpec
- The closure to use to configure the childCopySpec
.- Returns:
- this
-
isPreserveFileTimestamps
@Input public boolean isPreserveFileTimestamps()
Specifies whether file timestamps should be preserved in the archive.If
false
this ensures that archive entries have the same time for builds between different machines, Java versions and operating systems.- Returns:
true
if file timestamps should be preserved for archive entries- Since:
- 3.4
-
setPreserveFileTimestamps
public void setPreserveFileTimestamps(boolean preserveFileTimestamps)
Specifies whether file timestamps should be preserved in the archive.If
false
this ensures that archive entries have the same time for builds between different machines, Java versions and operating systems.- Parameters:
preserveFileTimestamps
-true
if file timestamps should be preserved for archive entries- Since:
- 3.4
-
isReproducibleFileOrder
@Input public boolean isReproducibleFileOrder()
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 order independent of file systems and operating systems. This helps Gradle reliably produce byte-for-byte reproducible archives.
- Returns:
true
if the files should read from disk in a reproducible order.- Since:
- 3.4
-
setReproducibleFileOrder
public void setReproducibleFileOrder(boolean reproducibleFileOrder)
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 order independent of file systems and operating systems. This helps Gradle reliably produce byte-for-byte reproducible archives.
- Parameters:
reproducibleFileOrder
-true
if the files should read from disk in a reproducible order.- Since:
- 3.4
-
createCopyActionExecuter
protected org.gradle.api.internal.file.copy.CopyActionExecuter createCopyActionExecuter()
- Overrides:
createCopyActionExecuter
in classAbstractCopyTask
-
-