gradle/org.gradle.api.file/CopyProcessingSpec

CopyProcessingSpec

interface CopyProcessingSpec : ContentFilterable(source)

Specifies the destination of a copy.

Inheritors

CopySpec

Functions

dirPermissions

abstract fun dirPermissions(configureAction: Action<in ConfigurableFilePermissions>): CopyProcessingSpec

Configuration action for specifying directory access permissions.

eachFile

abstract fun eachFile(@DelegatesTo(value = FileCopyDetails::class, strategy = Closure.DELEGATE_FIRST) closure: Closure): CopyProcessingSpec

Adds an action to be applied to each file as it about to be copied into its destination.

abstract fun eachFile(action: Action<in FileCopyDetails>): CopyProcessingSpec

Adds an action to be applied to each file as it is about to be copied into its destination.

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.

expand

inline fun ContentFilterable.expand(vararg properties: Pair<String, Any>): ContentFilterable

inline fun ContentFilterable.expand(vararg properties: Pair<String, Any>, action: Action<in ExpandDetails>): ContentFilterable

Kotlin extension function for org.gradle.api.file.ContentFilterable.expand.

filePermissions

abstract fun filePermissions(configureAction: Action<in ConfigurableFilePermissions>): CopyProcessingSpec

Configuration action for specifying file access permissions.

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.

filter

inline fun <T : FilterReader> ContentFilterable.filter(properties: Map<String, Any?>): ContentFilterable?

inline fun <T : FilterReader> ContentFilterable.filter(vararg properties: Pair<String, Any?>): ContentFilterable?

fun <T : FilterReader> ContentFilterable.filter(filterType: KClass<T>, properties: Map<String, Any?>): ContentFilterable?

fun <T : FilterReader> ContentFilterable.filter(filterType: KClass<T>, vararg properties: Pair<String, Any?>): ContentFilterable?

Adds a content filter to be used during the copy. Multiple calls add additional filters to the filter chain. Each filter should implement FilterReader. Import org.apache.tools.ant.filters.* for access to all the standard Ant filters.

inline fun ContentFilterable.filter(filterType: KClass<out FilterReader>): ContentFilterable

inline fun ContentFilterable.filter(filterType: KClass<out FilterReader>, vararg properties: Pair<String, Any>): ContentFilterable

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.file.ContentFilterable.filter.

getDirPermissions

abstract fun getDirPermissions(): Property<ConfigurableFilePermissions>

Property for querying and configuring directory access permissions.

getFilePermissions

abstract fun getFilePermissions(): Property<ConfigurableFilePermissions>

Property for querying and configuring file access permissions.

into

abstract fun into(destPath: Any): CopyProcessingSpec

Specifies the destination directory for a copy.

rename

abstract fun rename(closure: Closure): CopyProcessingSpec

abstract fun rename(renamer: Transformer<@Nullable String, String>): CopyProcessingSpec

Renames a source file.

abstract fun rename(sourceRegEx: String, replaceWith: String): CopyProcessingSpec

abstract fun rename(sourceRegEx: Pattern, replaceWith: String): CopyProcessingSpec

Renames files based on a regular expression.