org.gradle.api.internal.file.copy

Class CopyActionImpl

java.lang.Object

org.gradle.api.internal.file.copy.CopyActionImpl

All Implemented Interfaces:

ContentFilterable, CopyProcessingSpec, CopySourceSpec, CopySpec, CopyAction, CopySpecSource, PatternFilterable, WorkResult

Direct Known Subclasses:

FileCopyActionImpl

public class CopyActionImpl
extends Object
implements CopyAction, CopySpecSource

Author:

Steve Appling

Constructor Summary

Constructors

Constructor and Description
CopyActionImpl(FileResolver resolver, CopySpecVisitor visitor)

Method Summary

Methods

Modifier and Type	Method and Description
CopySpec	eachFile(Action<? super FileCopyDetails> action) Adds an action to be applied to each file as it is about to be copied into its destination.
CopySpec	eachFile(Closure closure) Adds an action to be applied to each file as it about to be copied into its destination.
CopySpec	exclude(Closure excludeSpec) Adds an exclude spec.
CopySpec	exclude(Iterable<String> excludes) Adds an ANT style exclude pattern.
CopySpec	exclude(Spec<FileTreeElement> excludeSpec) Adds an exclude spec.
CopySpec	exclude(String... excludes) Adds an ANT style exclude pattern.
void	execute()
CopySpec	expand(Map<String,?> properties) Expands property references in each file as it is copied.
CopySpec	filter(Class<? extends FilterReader> filterType) Adds a content filter to be used during the copy.
CopySpec	filter(Closure closure) Adds a content filter based on the provided closure.
CopySpec	filter(Map<String,?> properties, Class<? extends FilterReader> filterType) Adds a content filter to be used during the copy.
CopySpec	from(Object... sourcePaths) Specifies source files or directories for a copy.
CopySpec	from(Object sourcePath, Closure c) Specifies the source files or directories for a copy and creates a child CopySourceSpec.
FileTree	getAllSource()
boolean	getDidWork()
Integer	getDirMode() Returns the Unix permissions to use for the target directories.
Set<String>	getExcludes() Returns the set of exclude patterns.
Integer	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.
CopySpecImpl	getMainSpec()
FileResolver	getResolver()
CopySpecImpl	getRootSpec()
boolean	hasSource()
CopySpec	include(Closure includeSpec) Adds an include spec.
CopySpec	include(Iterable<String> includes) Adds an ANT style include pattern.
CopySpec	include(Spec<FileTreeElement> includeSpec) Adds an include spec.
CopySpec	include(String... includes) Adds an ANT style include pattern.
CopySpec	into(Object destDir) Specifies the destination directory for a copy.
CopySpec	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.
CopySpec	rename(Closure closure) Renames a source file to a different relative location under the target directory.
CopySpec	rename(Pattern sourceRegEx, String replaceWith) Renames files based on a regular expression.
CopySpec	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.
CopyProcessingSpec	setDirMode(Integer mode) Sets the Unix permissions to use for the target directories.
CopySpec	setExcludes(Iterable<String> excludes) Set the allowable exclude patterns.
CopyProcessingSpec	setFileMode(Integer 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.
CopySpec	setIncludes(Iterable<String> includes) Set the allowable include patterns.
CopySpec	with(CopySpec... copySpecs) Adds the given specs as a child of this spec.

Methods inherited from class java.lang.Object

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

Constructor Detail

CopyActionImpl

public CopyActionImpl(FileResolver resolver,
              CopySpecVisitor visitor)

Method Detail

getResolver

public FileResolver getResolver()

getRootSpec

public CopySpecImpl getRootSpec()

Specified by:

getRootSpec in interface CopySpecSource

getMainSpec

public CopySpecImpl getMainSpec()

execute

public void execute()

getDidWork

public boolean getDidWork()

Specified by:

getDidWork in interface WorkResult

getAllSource

public FileTree getAllSource()

hasSource

public boolean hasSource()

eachFile

public CopySpec eachFile(Action<? super FileCopyDetails> action)

Description copied from interface: CopySpec

Adds an action to be applied to each file as it is about to be copied into its destination. The action can change the destination path of the file, filter the contents of the file, or exclude the file from the result entirely. Actions are executed in the order added, and are inherited from the parent spec.

Specified by:

eachFile in interface CopyProcessingSpec

Specified by:

eachFile in interface CopySpec

Parameters:

action - The action to execute.

Returns:

this

eachFile

public CopySpec eachFile(Closure closure)

Description copied from interface: CopySpec

Adds an action to be applied to each file as it about to be copied into its destination. The given closure is called with a FileCopyDetails as its parameter. Actions are executed in the order added, and are inherited from the parent spec.

Specified by:

eachFile in interface CopyProcessingSpec

Specified by:

eachFile in interface CopySpec

Parameters:

closure - The action to execute.

Returns:

this

exclude

public CopySpec exclude(Iterable<String> excludes)

Description copied from interface: CopySpec

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. 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.

Specified by:

exclude in interface CopySpec

Specified by:

exclude in interface PatternFilterable

Parameters:

excludes - a Iterable providing new exclude patterns

Returns:

this

See Also:

Pattern Format

exclude

public CopySpec exclude(String... excludes)

Description copied from interface: CopySpec

Adds an ANT style exclude pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. 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.

Specified by:

exclude in interface CopySpec

Specified by:

exclude in interface PatternFilterable

Parameters:

excludes - a vararg list of exclude patterns

Returns:

this

See Also:

Pattern Format

exclude

public CopySpec exclude(Closure excludeSpec)

Description copied from interface: CopySpec

Adds an exclude spec. This method may be called multiple times to append new specs.The given closure is passed a 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.

Specified by:

exclude in interface CopySpec

Specified by:

exclude in interface PatternFilterable

Parameters:

excludeSpec - the spec to add

Returns:

this

See Also:

Pattern Format

exclude

public CopySpec exclude(Spec<FileTreeElement> excludeSpec)

Description copied from interface: CopySpec

Adds an exclude spec. This method may be called multiple times to append new specs. 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.

Specified by:

exclude in interface CopySpec

Specified by:

exclude in interface PatternFilterable

Parameters:

excludeSpec - the spec to add

Returns:

this

See Also:

Pattern Format

expand

public CopySpec expand(Map<String,?> properties)

Description copied from interface: CopySpec

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(' ')}

Specified by:

expand in interface ContentFilterable

Specified by:

expand in interface CopySpec

Parameters:

properties - to implement line based filtering

Returns:

this

filter

public CopySpec filter(Closure closure)

Description copied from interface: CopySpec

Adds a content filter based on the provided closure. The Closure will be called with each line (stripped of line endings) and should return a String to replace the line.

Specified by:

filter in interface ContentFilterable

Specified by:

filter in interface CopySpec

Parameters:

closure - to implement line based filtering

Returns:

this

filter

public CopySpec filter(Class<? extends FilterReader> filterType)

Description copied from interface: CopySpec

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)
 

Specified by:

filter in interface ContentFilterable

Specified by:

filter in interface CopySpec

Parameters:

filterType - Class of filter to add

Returns:

this

filter

public CopySpec filter(Map<String,?> properties,
              Class<? extends FilterReader> filterType)

Description copied from interface: CopySpec

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'])
 

Specified by:

filter in interface ContentFilterable

Specified by:

filter in interface CopySpec

Parameters:

properties - map of filter properties

filterType - Class of filter to add

Returns:

this

from

public CopySpec from(Object sourcePath,
            Closure c)

Description copied from interface: CopySpec

Specifies the source files or directories for a copy and creates a child CopySourceSpec. The given source path is evaluated as for Project.files(Object...) .

Specified by:

from in interface CopySourceSpec

Specified by:

from in interface CopySpec

Parameters:

sourcePath - Path to source for the copy

c - closure for configuring the child CopySourceSpec

from

public CopySpec from(Object... sourcePaths)

Description copied from interface: CopySpec

Specifies source files or directories for a copy. The given paths are evaluated as for Project.files(Object...).

Specified by:

from in interface CopySourceSpec

Specified by:

from in interface CopySpec

Parameters:

sourcePaths - Paths to source files for the copy

getExcludes

public Set<String> getExcludes()

Description copied from interface: PatternFilterable

Returns the set of exclude patterns.

Specified by:

getExcludes in interface PatternFilterable

Returns:

The exclude patterns. Returns an empty set when there are no exclude patterns.

getIncludes

public Set<String> getIncludes()

Description copied from interface: PatternFilterable

Returns the set of include patterns.

Specified by:

getIncludes in interface PatternFilterable

Returns:

The include patterns. Returns an empty set when there are no include patterns.

include

public CopySpec include(Iterable<String> includes)

Description copied from interface: CopySpec

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. 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 to be processed.

Specified by:

include in interface CopySpec

Specified by:

include in interface PatternFilterable

Parameters:

includes - a Iterable providing more include patterns

Returns:

this

See Also:

Pattern Format

include

public CopySpec include(String... includes)

Description copied from interface: CopySpec

Adds an ANT style include pattern. This method may be called multiple times to append new patterns and multiple patterns may be specified in a single call. 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 to be processed.

Specified by:

include in interface CopySpec

Specified by:

include in interface PatternFilterable

Parameters:

includes - a vararg list of include patterns

Returns:

this

See Also:

Pattern Format

include

public CopySpec include(Closure includeSpec)

Description copied from interface: CopySpec

Adds an include spec. This method may be called multiple times to append new specs. The given closure is passed a 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.

Specified by:

include in interface CopySpec

Specified by:

include in interface PatternFilterable

Parameters:

includeSpec - the spec to add

Returns:

this

See Also:

Pattern Format

include

public CopySpec include(Spec<FileTreeElement> includeSpec)

Description copied from interface: CopySpec

Adds an include spec. This method may be called multiple times to append new specs. 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.

Specified by:

include in interface CopySpec

Specified by:

include in interface PatternFilterable

Parameters:

includeSpec - the spec to add

Returns:

this

See Also:

Pattern Format

into

public CopySpec into(Object destDir)

Description copied from interface: CopySpec

Specifies the destination directory for a copy. The destination is evaluated as for Project.file(Object).

Specified by:

into in interface CopyProcessingSpec

Specified by:

into in interface CopySpec

Parameters:

destDir - Path to the destination directory for a Copy

Returns:

this

into

public CopySpec into(Object destPath,
            Closure configureClosure)

Description copied from interface: CopySpec

Creates and configures a child CopySpec with the given destination path. The destination is evaluated as for Project.file(Object).

Specified by:

into in interface CopySpec

Parameters:

destPath - Path to the destination directory for a Copy

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

Returns:

this

isCaseSensitive

public boolean isCaseSensitive()

Description copied from interface: CopySpec

Specifies whether case-sensitive pattern matching should be used.

Specified by:

isCaseSensitive in interface CopySpec

Returns:

true for case-sensitive matching.

getIncludeEmptyDirs

public boolean getIncludeEmptyDirs()

Description copied from interface: CopySpec

Tells if empty target directories will be included in the copy.

Specified by:

getIncludeEmptyDirs in interface CopySpec

Returns:

true if empty target directories will be included in the copy, false otherwise

setIncludeEmptyDirs

public void setIncludeEmptyDirs(boolean includeEmptyDirs)

Description copied from interface: CopySpec

Controls if empty target directories should be included in the copy.

Specified by:

setIncludeEmptyDirs in interface CopySpec

Parameters:

includeEmptyDirs - true if empty target directories should be included in the copy, false otherwise

rename

public CopySpec rename(Closure closure)

Description copied from interface: CopySpec

Renames a source file to a different relative location under the target directory. The closure will be called with a single parameter, the name of the file. The closure should return a String object with a new target name. The closure may return null, in which case the original name will be used.

Specified by:

rename in interface CopyProcessingSpec

Specified by:

rename in interface CopySpec

Parameters:

closure - rename closure

Returns:

this

rename

public CopySpec rename(Pattern sourceRegEx,
              String replaceWith)

Description copied from interface: CopySpec

Renames files based on a regular expression. See CopyProcessingSpec.rename(String, String).

Specified by:

rename in interface CopyProcessingSpec

Specified by:

rename in interface CopySpec

Parameters:

sourceRegEx - Source regular expression

replaceWith - Replacement string (use $ syntax for capture groups)

Returns:

this

rename

public CopySpec rename(String sourceRegEx,
              String replaceWith)

Description copied from interface: CopySpec

Renames files based on a regular expression. Uses java.util.regex type of regular expressions. Note that the replace string should use the '$1' syntax to refer to capture groups in the source regular expression. Files that do not match the source regular expression will be copied with the original name.

Example:

 rename '(.*)_OEM_BLUE_(.*)', '$1$2'
 

would map the file 'style_OEM_BLUE_.css' to 'style.css'

Specified by:

rename in interface CopyProcessingSpec

Specified by:

rename in interface CopySpec

Parameters:

sourceRegEx - Source regular expression

replaceWith - Replacement string (use $ syntax for capture groups)

Returns:

this

setCaseSensitive

public void setCaseSensitive(boolean caseSensitive)

Description copied from interface: CopySpec

Specifies whether case-sensitive pattern matching should be used for this CopySpec.

Specified by:

setCaseSensitive in interface CopySpec

Parameters:

caseSensitive - true for case-sensitive matching.

getDirMode

public Integer getDirMode()

Description copied from interface: CopyProcessingSpec

Returns the Unix permissions to use for the target directories. null means that existing permissions are preserved. It is dependent on the copy action implementation whether these permissions will actually be applied.

Specified by:

getDirMode in interface CopyProcessingSpec

Returns:

The directory permissions, or null if existing permissions should be preserved.

setDirMode

public CopyProcessingSpec setDirMode(Integer mode)

Description copied from interface: CopyProcessingSpec

Sets the Unix permissions to use for the target directories. null means that existing permissions are preserved. It is dependent on the copy action implementation whether these permissions will actually be applied.

Specified by:

setDirMode in interface CopyProcessingSpec

Parameters:

mode - The directory permissions.

Returns:

this

setExcludes

public CopySpec setExcludes(Iterable<String> excludes)

Description copied from interface: CopySpec

Set the allowable exclude patterns. Note that unlike PatternFilterable.exclude(Iterable) this replaces any previously defined excludes.

Specified by:

setExcludes in interface CopySpec

Specified by:

setExcludes in interface PatternFilterable

Parameters:

excludes - an Iterable providing new exclude patterns

Returns:

this

See Also:

Pattern Format

getFileMode

public Integer getFileMode()

Description copied from interface: CopyProcessingSpec

Returns the Unix permissions to use for the target files. null means that existing permissions are preserved. It is dependent on the copy action implementation whether these permissions will actually be applied.

Specified by:

getFileMode in interface CopyProcessingSpec

Returns:

The file permissions, or null if existing permissions should be preserved.

setFileMode

public CopyProcessingSpec setFileMode(Integer mode)

Description copied from interface: CopyProcessingSpec

Sets the Unix permissions to use for the target files. null means that existing permissions are preserved. It is dependent on the copy action implementation whether these permissions will actually be applied.

Specified by:

setFileMode in interface CopyProcessingSpec

Parameters:

mode - The file permissions.

Returns:

this

setIncludes

public CopySpec setIncludes(Iterable<String> includes)

Description copied from interface: CopySpec

Set the allowable include patterns. Note that unlike PatternFilterable.include(Iterable) this replaces any previously defined includes.

Specified by:

setIncludes in interface CopySpec

Specified by:

setIncludes in interface PatternFilterable

Parameters:

includes - an Iterable providing new include patterns

Returns:

this

See Also:

Pattern Format

with

public CopySpec with(CopySpec... copySpecs)

Description copied from interface: CopySpec

Adds the given specs as a child of this spec.

Specified by:

with in interface CopySpec

Parameters:

copySpecs - The specs to add

Returns:

this