gradle/org.gradle.api.file/FileCopyDetails

FileCopyDetails

interface FileCopyDetails : FileTreeElement, ContentFilterable, Describable(source)

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.

Access to the source file itself after any filters have been added is not a supported operation.

Functions

copyTo

abstract fun copyTo(target: File): Boolean

Copies this file to the given target file.

abstract fun copyTo(output: OutputStream)

Copies the content of this file to an output stream.

exclude

abstract fun exclude()

Excludes this file from the copy.

expand

abstract fun expand(properties: Map<String, out Any>): ContentFilterable

abstract fun expand(properties: Map<String, out Any>, action: Action<in ExpandDetails>): ContentFilterable

Expands property references in each file as it is copied.

filter

abstract fun filter(closure: Closure): ContentFilterable

Adds a content filter based on the provided closure.

abstract fun filter(filterType: Class<out FilterReader>): ContentFilterable

abstract fun filter(properties: Map<String, out Any>, filterType: Class<out FilterReader>): ContentFilterable

Adds a content filter to be used during the copy.

abstract fun filter(transformer: Transformer<@Nullable String, String>): ContentFilterable

Adds a content filter based on the provided transformer.

getDisplayName

abstract fun getDisplayName(): String

Returns the display name of this object.

getDuplicatesStrategy

abstract fun getDuplicatesStrategy(): DuplicatesStrategy

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

getFile

abstract fun getFile(): File

Returns the file being visited.

getLastModified

abstract fun getLastModified(): Long

Returns the last modified time of this file at the time of file traversal.

getName

abstract fun getName(): String

Returns the base name of this file at the copy destination.

getPath

abstract fun getPath(): String

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

getPermissions

abstract fun getPermissions(): FilePermissions

Provides a read-only view of access permissions of this file.

getRelativePath

abstract fun getRelativePath(): RelativePath

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

getRelativeSourcePath

abstract fun getRelativeSourcePath(): RelativePath

Returns the path of this file, relative to the root of the containing file tree.

getSize

abstract fun getSize(): Long

Returns the size of this file at the time of file traversal.

getSourceName

abstract fun getSourceName(): String

Returns the base name of this file at the copy source.

getSourcePath

abstract fun getSourcePath(): String

Returns the path of this file, relative to the root of the containing file tree.

isDirectory

abstract fun isDirectory(): Boolean

Returns true if this element is a directory, or false if this element is a regular file.

open

abstract fun open(): InputStream

Opens this file as an input stream.

permissions

abstract fun permissions(configureAction: Action<in ConfigurableFilePermissions>)

Configuration action for specifying file and directory access permissions.

setDuplicatesStrategy

abstract fun setDuplicatesStrategy(strategy: DuplicatesStrategy)

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

setName

abstract fun setName(name: String)

Sets the destination name of this file.

setPath

abstract fun setPath(path: String)

Sets the destination path of this file.

setPermissions

abstract fun setPermissions(permissions: FilePermissions)

Set file and directory access permissions based on an externally provided permission instance.

setRelativePath

abstract fun setRelativePath(path: RelativePath)

Sets the destination path of this file.