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, DynamicObjectAware, CopySpecSource, IConventionAware, TaskInternal, ExtensionAware, Task, PatternFilterable, Configurable<Task>

Direct Known Subclasses:

Tar, Zip

public abstract class AbstractArchiveTask
extends AbstractCopyTask

AbstractArchiveTask is the base class for all archive tasks.

Author:

Hans Dockter

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_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

Constructor Summary

Constructors

Constructor and Description
AbstractArchiveTask()

Method Summary

Methods

Modifier and Type	Method and Description
String	getAppendix() Returns the appendix part of the archive name, if any.
String	getArchiveName() Returns the archive name.
File	getArchivePath() The path where the archive is constructed.
String	getBaseName() Returns the base name of the archive.
String	getClassifier() Returns the classifier part of the archive name, if any.
File	getDestinationDir() Returns the directory where the archive is generated into.
String	getExtension() Returns the extension part of the archive name.
String	getVersion() Returns the version part of the archive name, if any.
AbstractArchiveTask	into(Object destPath) Specifies the destination directory *inside* the archive for the files.
AbstractArchiveTask	into(Object destPath, Closure configureClosure) Creates and configures a child CopySpec with a destination directory *inside* the archive for the files.
void	setAppendix(String appendix)
void	setArchiveName(String name) Sets the archive name.
void	setBaseName(String baseName)
void	setClassifier(String classifier)
void	setDestinationDir(File destinationDir)
void	setExtension(String extension)
void	setVersion(String version)

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

configureRootSpec, copy, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, filter, filter, filter, from, from, getCopyAction, getDefaultSource, getDirMode, getExcludes, getFileMode, getIncludeEmptyDirs, getIncludes, getMainSpec, getRootSpec, getSource, include, include, include, include, isCaseSensitive, rename, rename, rename, setCaseSensitive, setDirMode, 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, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDidWork, getDynamicObjectHelper, getEnabled, getExecuter, getExtensions, getGroup, getInputs, getLogger, getLogging, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getStandardOutputCapture, getState, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, leftShift, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setGroup, setName, setOnlyIf, setOnlyIf, setProject, setProperty, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractArchiveTask

public AbstractArchiveTask()

Method Detail

getArchiveName

public String getArchiveName()

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

public void setArchiveName(String name)

Sets the archive name.

Parameters:

name - the archive name.

getArchivePath

public File getArchivePath()

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

Returns:

a File object with the path to the archive

getDestinationDir

public File getDestinationDir()

Returns the directory where the archive is generated into.

Returns:

the directory

setDestinationDir

public void setDestinationDir(File destinationDir)

getBaseName

public String getBaseName()

Returns the base name of the archive.

Returns:

the base name.

setBaseName

public void setBaseName(String baseName)

getAppendix

public String getAppendix()

Returns the appendix part of the archive name, if any.

Returns:

the appendix. May be null

setAppendix

public void setAppendix(String appendix)

getVersion

public String getVersion()

Returns the version part of the archive name, if any.

Returns:

the version. May be null.

setVersion

public void setVersion(String version)

getExtension

public String getExtension()

Returns the extension part of the archive name.

setExtension

public void setExtension(String extension)

getClassifier

public String getClassifier()

Returns the classifier part of the archive name, if any.

Returns:

The classifier. May be null.

setClassifier

public void setClassifier(String classifier)

into

public AbstractArchiveTask into(Object destPath)

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

Specified by:

into in interface CopyProcessingSpec

Specified by:

into in interface CopySpec

Overrides:

into in class AbstractCopyTask

Parameters:

destPath - destination directory *inside* the archive for the files

Returns:

this

into

public 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 for Project.file(Object). Don't mix it up with getDestinationDir() which specifies the output directory for the archive.

Specified by:

into in interface CopySpec

Overrides:

into in class AbstractCopyTask

Parameters:

destPath - destination directory *inside* the archive for the files

configureClosure - The closure to use to configure the child CopySpec.

Returns:

this