org.gradle.api.file

Interface FileCopyDetails

All Superinterfaces:

ContentFilterable, FileTreeElement

@NonExtensible
public interface FileCopyDetails
extends FileTreeElement, ContentFilterable

Provides details about a file or directory about to be copied, and allows some aspects of the destination file to be modified.

Using this interface, you can change the destination path of the file, filter the content of the file, or exclude the file from the result entirely.

Method Summary

Methods

Modifier and Type	Method and Description
void	exclude() Excludes this file from the copy.
DuplicatesStrategy	getDuplicatesStrategy() The strategy to use if there is already a file at this file's destination.
String	getPath() Returns the path of this file, relative to the root of the copy destination.
RelativePath	getRelativePath() Returns the path of this file, relative to the root of the copy destination.
void	setDuplicatesStrategy(DuplicatesStrategy strategy) The strategy to use if there is already a file at this file's destination.
void	setMode(int mode) Sets the Unix permissions of this file.
void	setName(String name) Sets the destination name of this file.
void	setPath(String path) Sets the destination path of this file.
void	setRelativePath(RelativePath path) Sets the destination path of this file.

Methods inherited from interface org.gradle.api.file.FileTreeElement

copyTo, copyTo, getFile, getLastModified, getMode, getName, getSize, isDirectory, open

Methods inherited from interface org.gradle.api.file.ContentFilterable

expand, filter, filter, filter

Method Detail

exclude

void exclude()

Excludes this file from the copy.

setName

void setName(String name)

Sets the destination name of this file.

Parameters:

name - The name of this file.

setPath

void setPath(String path)

Sets the destination path of this file.

Parameters:

path - The path of this file.

setRelativePath

void setRelativePath(RelativePath path)

Sets the destination path of this file.

Parameters:

path - the new path for this file.

setMode

void setMode(int mode)

Sets the Unix permissions of this file.

Parameters:

mode - the Unix permissions, e.g. 0644.

setDuplicatesStrategy

@Incubating
void setDuplicatesStrategy(DuplicatesStrategy strategy)

The strategy to use if there is already a file at this file's destination.

getDuplicatesStrategy

@Incubating
DuplicatesStrategy getDuplicatesStrategy()

The strategy to use if there is already a file at this file's destination.

The value can be set with a case insensitive string of the enum value (e.g. 'exclude' for DuplicatesStrategy.EXCLUDE).

Returns:

the strategy to use for this file.

See Also:

DuplicatesStrategy

getPath

String getPath()

Returns the path of this file, relative to the root of the copy destination.

Always uses '/' as the hierarchy separator, regardless of platform file separator. Same as calling getRelativePath().getPathString().

Specified by:

getPath in interface FileTreeElement

Returns:

The path. Never returns null.

getRelativePath

RelativePath getRelativePath()

Returns the path of this file, relative to the root of the copy destination.

Specified by:

getRelativePath in interface FileTreeElement

Returns:

The path. Never returns null.