gradle
8.4

# CopyProcessingSpec

interface CopyProcessingSpec : ContentFilterable(source)

Specifies the destination of a copy.

#### Inheritors

CopySpec

## Functions

dirPermissions
Link copied to clipboard
@Incubating
abstract fun dirPermissions(configureAction: Action<out Any>): CopyProcessingSpec
Configuration action for specifying directory access permissions.
eachFile
Link copied to clipboard
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<out Any>): CopyProcessingSpec
Adds an action to be applied to each file as it is about to be copied into its destination.
expand
Link copied to clipboard
abstract fun expand(properties: Map<String, out Any>): ContentFilterable
expand
Link copied to clipboard
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
Link copied to clipboard
@Incubating
abstract fun filePermissions(configureAction: Action<out Any>): CopyProcessingSpec
Configuration action for specifying file access permissions.
filter
Link copied to clipboard
abstract fun filter(properties: Map<String, out Any>, filterType: Class<out FilterReader>): ContentFilterable
filter
Link copied to clipboard
inline fun <T : FilterReader> ContentFilterable.filter(vararg properties: Pair<String, Any?>): ContentFilterable
inline fun <T : FilterReader> ContentFilterable.filter(properties: Map<String, Any?>): ContentFilterable
fun <T : FilterReader> ContentFilterable.filter(filterType: KClass<T>, vararg properties: Pair<String, Any?>): ContentFilterable
fun <T : FilterReader> ContentFilterable.filter(filterType: KClass<T>, properties: Map<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.

getDirMode
Link copied to clipboard
@Nullable
abstract fun getDirMode(): Integer
Returns the Unix permissions to use for the target directories.
getDirPermissions
Link copied to clipboard
@Incubating
abstract fun getDirPermissions(): Property<ConfigurableFilePermissions>
Property for configuring directory access permissions.
getFileMode
Link copied to clipboard
@Nullable
abstract fun getFileMode(): Integer
Returns the Unix permissions to use for the target files.
getFilePermissions
Link copied to clipboard
@Incubating
abstract fun getFilePermissions(): Property<ConfigurableFilePermissions>
Property for configuring file access permissions.
into
Link copied to clipboard
abstract fun into(destPath: Any): CopyProcessingSpec
Specifies the destination directory for a copy.
rename
Link copied to clipboard
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.
setDirMode
Link copied to clipboard
abstract fun setDirMode(@Nullable mode: Integer): CopyProcessingSpec
Sets the Unix permissions to use for the target directories.
setFileMode
Link copied to clipboard
abstract fun setFileMode(@Nullable mode: Integer): CopyProcessingSpec
Sets the Unix permissions to use for the target files.