|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.gradle.api.internal.AbstractTask org.gradle.api.DefaultTask org.gradle.api.internal.ConventionTask org.gradle.api.tasks.AbstractCopyTask
public abstract class AbstractCopyTask
AbstractCopyTask
is the base class for all copy 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_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE |
Constructor Summary | |
---|---|
AbstractCopyTask()
|
Method Summary | |
---|---|
protected void |
configureRootSpec()
|
protected void |
copy()
|
AbstractCopyTask |
eachFile(Action<? super FileCopyDetails> action)
Adds an action to be applied to each file as it about to be copied into its destination. |
AbstractCopyTask |
eachFile(Closure closure)
Adds an action to be applied to each file as it about to be copied into its destination. |
AbstractCopyTask |
exclude(Closure excludeSpec)
Adds an exclude spec. |
AbstractCopyTask |
exclude(Iterable<String> excludes)
Adds an ANT style exclude pattern. |
AbstractCopyTask |
exclude(Spec<FileTreeElement> excludeSpec)
Adds an exclude spec. |
AbstractCopyTask |
exclude(String... excludes)
Adds an ANT style exclude pattern. |
AbstractCopyTask |
expand(Map<String,?> properties)
Expands property references in each file as it is copied. |
AbstractCopyTask |
filter(Class<? extends FilterReader> filterType)
Adds a content filter to be used during the copy. |
AbstractCopyTask |
filter(Closure closure)
Adds a content filter based on the provided closure. |
AbstractCopyTask |
filter(Map<String,?> properties,
Class<? extends FilterReader> filterType)
Adds a content filter to be used during the copy. |
AbstractCopyTask |
from(Object... sourcePaths)
Specifies source files or directories for a copy. |
AbstractCopyTask |
from(Object sourcePath,
Closure c)
Specifies the source files or directories for a copy and creates a child CopySourceSpec . |
protected abstract org.gradle.api.internal.file.copy.CopyActionImpl |
getCopyAction()
|
FileCollection |
getDefaultSource()
|
int |
getDirMode()
Returns the Unix permissions to use for the target directories. |
Set<String> |
getExcludes()
Returns the set of exclude patterns. |
int |
getFileMode()
Returns the Unix permissions to use for the target files. |
boolean |
getIncludeEmptyDirs()
Tells if empty target directories will be included in the copy. |
Set<String> |
getIncludes()
Returns the set of include patterns. |
protected CopySpec |
getMainSpec()
|
org.gradle.api.internal.file.copy.ReadableCopySpec |
getRootSpec()
|
FileCollection |
getSource()
Returns the source files for this task. |
AbstractCopyTask |
include(Closure includeSpec)
Adds an include spec. |
AbstractCopyTask |
include(Iterable<String> includes)
Adds an ANT style include pattern. |
AbstractCopyTask |
include(Spec<FileTreeElement> includeSpec)
Adds an include spec. |
AbstractCopyTask |
include(String... includes)
Adds an ANT style include pattern. |
AbstractCopyTask |
into(Object destDir)
Specifies the destination directory for a copy. |
AbstractCopyTask |
into(Object destPath,
Closure configureClosure)
Creates and configures a child CopySpec with the given destination path. |
boolean |
isCaseSensitive()
Specifies whether case-sensitive pattern matching should be used. |
AbstractCopyTask |
rename(Closure closure)
Renames a source file to a different relative location under the target directory. |
AbstractCopyTask |
rename(Pattern sourceRegEx,
String replaceWith)
Renames files based on a regular expression. |
AbstractCopyTask |
rename(String sourceRegEx,
String replaceWith)
Renames files based on a regular expression. |
void |
setCaseSensitive(boolean caseSensitive)
Specifies whether case-sensitive pattern matching should be used for this CopySpec. |
AbstractCopyTask |
setDirMode(int mode)
Sets the Unix permissions to use for the target directories. |
AbstractCopyTask |
setExcludes(Iterable<String> excludes)
Set the allowable exclude patterns. |
AbstractCopyTask |
setFileMode(int mode)
Sets the Unix permissions to use for the target files. |
void |
setIncludeEmptyDirs(boolean includeEmptyDirs)
Controls if empty target directories should be included in the copy. |
AbstractCopyTask |
setIncludes(Iterable<String> includes)
Set the allowable include patterns. |
CopySpec |
with(CopySpec... sourceSpecs)
Adds the given specs as a child of this spec. |
Methods inherited from class org.gradle.api.internal.ConventionTask |
---|
conventionMapping, getConventionMapping, setConventionMapping |
Methods inherited from class org.gradle.api.internal.AbstractTask |
---|
addValidator, captureStandardOutput, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, disableStandardOutputCapture, doFirst, doFirst, doLast, doLast, execute, executeWithoutThrowingTaskFailure, getActions, getAdditionalProperties, 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 |
---|
public AbstractCopyTask()
Method Detail |
---|
protected void copy()
protected void configureRootSpec()
public FileCollection getDefaultSource()
public FileCollection getSource()
protected abstract org.gradle.api.internal.file.copy.CopyActionImpl getCopyAction()
public org.gradle.api.internal.file.copy.ReadableCopySpec getRootSpec()
getRootSpec
in interface org.gradle.api.internal.file.copy.CopySpecSource
protected CopySpec getMainSpec()
public boolean isCaseSensitive()
isCaseSensitive
in interface CopySpec
public void setCaseSensitive(boolean caseSensitive)
setCaseSensitive
in interface CopySpec
caseSensitive
- true for case-sensitive matching.public boolean getIncludeEmptyDirs()
getIncludeEmptyDirs
in interface CopySpec
public void setIncludeEmptyDirs(boolean includeEmptyDirs)
setIncludeEmptyDirs
in interface CopySpec
includeEmptyDirs
- true if empty target directories should be included in the copy, false otherwisepublic AbstractCopyTask from(Object... sourcePaths)
Project.files(Object...)
.
from
in interface CopySourceSpec
from
in interface CopySpec
sourcePaths
- Paths to source files for the copypublic AbstractCopyTask from(Object sourcePath, Closure c)
CopySourceSpec
. The given source
path is evaluated as for Project.files(Object...)
.
from
in interface CopySourceSpec
from
in interface CopySpec
sourcePath
- Path to source for the copyc
- closure for configuring the child CopySourceSpecpublic CopySpec with(CopySpec... sourceSpecs)
with
in interface CopySpec
sourceSpecs
- The specs to add
public AbstractCopyTask into(Object destDir)
Project.file(Object)
.
into
in interface CopyProcessingSpec
into
in interface CopySpec
destDir
- Path to the destination directory for a Copy
public AbstractCopyTask into(Object destPath, Closure configureClosure)
CopySpec
with the given destination path.
The destination is evaluated as for Project.file(Object)
.
into
in interface CopySpec
destPath
- Path to the destination directory for a CopyconfigureClosure
- The closure to use to configure the child CopySpec
.
public AbstractCopyTask include(String... includes)
include
in interface CopySpec
include
in interface PatternFilterable
includes
- a vararg list of include patterns
Pattern Format
public AbstractCopyTask include(Iterable<String> includes)
include
in interface CopySpec
include
in interface PatternFilterable
includes
- a Iterable providing more include patterns
Pattern Format
public AbstractCopyTask include(Spec<FileTreeElement> includeSpec)
include
in interface CopySpec
include
in interface PatternFilterable
includeSpec
- the spec to add
Pattern Format
public AbstractCopyTask include(Closure includeSpec)
FileTreeElement
as its parameter.
If includes are not provided, then all files in this container will be included. If includes are provided, then a
file must match at least one of the include patterns or specs to be included.
include
in interface CopySpec
include
in interface PatternFilterable
includeSpec
- the spec to add
Pattern Format
public AbstractCopyTask exclude(String... excludes)
exclude
in interface CopySpec
exclude
in interface PatternFilterable
excludes
- a vararg list of exclude patterns
Pattern Format
public AbstractCopyTask exclude(Iterable<String> excludes)
exclude
in interface CopySpec
exclude
in interface PatternFilterable
excludes
- a Iterable providing new exclude patterns
Pattern Format
public AbstractCopyTask exclude(Spec<FileTreeElement> excludeSpec)
exclude
in interface CopySpec
exclude
in interface PatternFilterable
excludeSpec
- the spec to add
Pattern Format
public AbstractCopyTask exclude(Closure excludeSpec)
FileTreeElement
as its parameter.
If excludes are not provided, then no files will be excluded. If excludes are provided, then files must not match
any exclude pattern to be processed.
exclude
in interface CopySpec
exclude
in interface PatternFilterable
excludeSpec
- the spec to add
Pattern Format
public AbstractCopyTask setIncludes(Iterable<String> includes)
PatternFilterable.include(Iterable)
this replaces any previously
defined includes.
setIncludes
in interface CopySpec
setIncludes
in interface PatternFilterable
includes
- an Iterable providing new include patterns
Pattern Format
public Set<String> getIncludes()
getIncludes
in interface PatternFilterable
public AbstractCopyTask setExcludes(Iterable<String> excludes)
PatternFilterable.exclude(Iterable)
this replaces any previously
defined excludes.
setExcludes
in interface CopySpec
setExcludes
in interface PatternFilterable
excludes
- an Iterable providing new exclude patterns
Pattern Format
public Set<String> getExcludes()
getExcludes
in interface PatternFilterable
public AbstractCopyTask rename(Closure closure)
rename
in interface CopyProcessingSpec
rename
in interface CopySpec
closure
- rename closure
public AbstractCopyTask rename(String sourceRegEx, String replaceWith)
Example:
rename '(.*)_OEM_BLUE_(.*)', '$1$2'would map the file 'style_OEM_BLUE_.css' to 'style.css'
rename
in interface CopyProcessingSpec
rename
in interface CopySpec
sourceRegEx
- Source regular expressionreplaceWith
- Replacement string (use $ syntax for capture groups)
public AbstractCopyTask rename(Pattern sourceRegEx, String replaceWith)
CopyProcessingSpec.rename(String, String)
.
rename
in interface CopyProcessingSpec
rename
in interface CopySpec
sourceRegEx
- Source regular expressionreplaceWith
- Replacement string (use $ syntax for capture groups)
public AbstractCopyTask filter(Map<String,?> properties, Class<? extends FilterReader> filterType)
Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to the
filter chain. Each filter should implement java.io.FilterReader
. Include org.apache.tools.ant.filters.*
for access to all the standard Ant filters.
Filter properties may be specified using groovy map syntax.
Examples:
filter(HeadFilter, lines:25, skip:2) filter(ReplaceTokens, tokens:[copyright:'2009', version:'2.3.1'])
filter
in interface ContentFilterable
filter
in interface CopySpec
properties
- map of filter propertiesfilterType
- Class of filter to add
public AbstractCopyTask filter(Class<? extends FilterReader> filterType)
Adds a content filter to be used during the copy. Multiple calls to filter, add additional filters to the
filter chain. Each filter should implement java.io.FilterReader
. Include org.apache.tools.ant.filters.*
for access to all the standard Ant filters.
Examples:
filter(StripJavaComments) filter(com.mycompany.project.CustomFilter)
filter
in interface ContentFilterable
filter
in interface CopySpec
filterType
- Class of filter to add
public AbstractCopyTask filter(Closure closure)
filter
in interface ContentFilterable
filter
in interface CopySpec
closure
- to implement line based filtering
public AbstractCopyTask expand(Map<String,?> properties)
Expands property references in each file as it is copied. More specifically, each file is transformed using
Groovy's SimpleTemplateEngine
. This means you can use simple property references, such as
$property
or ${property}
in the file. You can also include arbitrary Groovy code in the
file, such as ${version ?: 'unknown'}
or ${classpath*.name.join(' ')}
expand
in interface ContentFilterable
expand
in interface CopySpec
properties
- to implement line based filtering
public int getDirMode()
getDirMode
in interface CopyProcessingSpec
public int getFileMode()
getFileMode
in interface CopyProcessingSpec
public AbstractCopyTask setDirMode(int mode)
setDirMode
in interface CopyProcessingSpec
mode
- The directory permissions.
public AbstractCopyTask setFileMode(int mode)
setFileMode
in interface CopyProcessingSpec
mode
- The file permissions.
public AbstractCopyTask eachFile(Action<? super FileCopyDetails> action)
eachFile
in interface CopyProcessingSpec
eachFile
in interface CopySpec
action
- The action to execute.
public AbstractCopyTask eachFile(Closure closure)
FileCopyDetails
as its parameter. Actions are executed in the order
added, and are inherited from the parent spec.
eachFile
in interface CopyProcessingSpec
eachFile
in interface CopySpec
closure
- The action to execute.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |