api / org.gradle.kotlin.dsl / org.gradle.api.file.ContentFilterable / filter

filter

inline fun <reified T : FilterReader> ContentFilterable.filter(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.

Examples:

filter<StripJavaComments>()
filter<com.mycompany.project.CustomFilter>()
filter<HeadFilter>("lines" to 25, "skip" to 2)
filter<ReplaceTokens>("tokens" to mapOf("copyright" to "2009", "version" to "2.3.1"))

Parameters

T - type of the filter to add

properties - map of filter properties

Return
this

inline fun <reified T : FilterReader> ContentFilterable.filter(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.

Examples:

filter<HeadFilter>(mapOf("lines" to 25, "skip" to 2))
filter<ReplaceTokens>(mapOf("tokens" to mapOf("copyright" to "2009", "version" to "2.3.1")))

Parameters

T - type of the filter to add

properties - map of filter properties

Return
this

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.

Examples:

filter(StripJavaComments::class)
filter(com.mycompany.project.CustomFilter::class)
filter(HeadFilter::class, "lines" to 25, "skip" to 2)
filter(ReplaceTokens::class, "tokens" to mapOf("copyright" to "2009", "version" to "2.3.1"))

Parameters

filterType - type of the filter to add

properties - map of filter properties

Return
this

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.

Examples:

filter(HeadFilter::class, mapOf("lines" to 25, "skip" to 2))
filter(ReplaceTokens::class, mapOf("tokens" to mapOf("copyright" to "2009", "version" to "2.3.1")))

Parameters

filterType - type of the filter to add

properties - map of filter properties

Return
this