# Tar

@DisableCachingByDefault(because = "Not worth caching")
abstract class Tar : AbstractArchiveTask(source)

Assembles a TAR archive.

## Constructors

Tar
Link copied to clipboard
constructor()

## Properties

archiveAppendix
Link copied to clipboard
val archiveAppendix: Property<String>
archiveBaseName
Link copied to clipboard
val archiveBaseName: Property<String>
archiveClassifier
Link copied to clipboard
val archiveClassifier: Property<String>
archiveExtension
Link copied to clipboard
val archiveExtension: Property<String>
archiveVersion
Link copied to clipboard
val archiveVersion: Property<String>
compression
Link copied to clipboard
@get: Input
open var compression: Compression
conventionMapping
Link copied to clipboard
open val conventionMapping: ConventionMapping
description
Link copied to clipboard
open var description: String
enabled
Link copied to clipboard
open var enabled: Boolean
extra
Link copied to clipboard
val ExtensionAware. extra: ExtraPropertiesExtension

The extra properties extension in this object's extension container.

group
Link copied to clipboard
open var group: String
impliesSubProjects
Link copied to clipboard
open var impliesSubProjects: Boolean
rootSpec
Link copied to clipboard
val rootSpec: CopySpecInternal
state
Link copied to clipboard
val state: TaskStateInternal
TASK_ACTION
Link copied to clipboard
val TASK_ACTION: String = "action"
TASK_CONSTRUCTOR_ARGS
Link copied to clipboard
val TASK_CONSTRUCTOR_ARGS: String = "constructorArgs"
TASK_DEPENDS_ON
Link copied to clipboard
val TASK_DEPENDS_ON: String = "dependsOn"
TASK_DESCRIPTION
Link copied to clipboard
val TASK_DESCRIPTION: String = "description"
TASK_GROUP
Link copied to clipboard
val TASK_GROUP: String = "group"
TASK_NAME
Link copied to clipboard
val TASK_NAME: String = "name"
TASK_OVERWRITE
Link copied to clipboard
val TASK_OVERWRITE: String = "overwrite"
TASK_TYPE
Link copied to clipboard
val TASK_TYPE: String = "type"
timeout
Link copied to clipboard
val timeout: Property<Duration>

## Functions

acceptServiceReferences
Link copied to clipboard
open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)
appendParallelSafeAction
Link copied to clipboard
open fun appendParallelSafeAction(action: Action<in Task>)
compareTo
Link copied to clipboard
open fun compareTo(otherTask: Task): Int
configure
Link copied to clipboard
open fun configure(closure: Closure): Task
abstract fun configure(cl: Closure): T
configure
Link copied to clipboard
inline fun <T : Any> ExtensionAware. configure(noinline configuration: T.() -> Unit)

Executes the given configuration block against the extension of the specified type.

conventionMapping
Link copied to clipboard
open fun conventionMapping(property: String, mapping: Callable<out Any>): Task
dependsOn
Link copied to clipboard
open fun dependsOn(paths: Array<Any>): Task
dirPermissions
Link copied to clipboard
open fun dirPermissions(configureAction: Action<in ConfigurableFilePermissions>): CopyProcessingSpec
doFirst
Link copied to clipboard
open fun doFirst(action: Action<in Task>): Task
doLast
Link copied to clipboard
open fun doLast(action: Action<in Task>): Task
doNotTrackState
Link copied to clipboard
open fun doNotTrackState(reasonNotToTrackState: String)
eachFile
Link copied to clipboard
abstract fun eachFile(action: Action<in FileCopyDetails>): CopyProcessingSpec
abstract fun eachFile(action: Action<in FileCopyDetails>): CopySpec
open fun eachFile(action: Action<in FileCopyDetails>): AbstractCopyTask
exclude
Link copied to clipboard
abstract fun exclude(excludes: Array<String>): CopySpec
open fun exclude(excludes: Array<String>): AbstractCopyTask
abstract fun exclude(excludes: Array<String>): PatternFilterable
expand
Link copied to clipboard
abstract fun expand(properties: Map<String, out Any>): ContentFilterable
abstract fun expand(properties: Map<String, out Any>): CopySpec
open fun expand(properties: Map<String, out Any>): AbstractCopyTask
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.

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

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

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

Kotlin extension function for org.gradle.api.tasks.AbstractCopyTask.expand.

filePermissions
Link copied to clipboard
open fun filePermissions(configureAction: Action<in ConfigurableFilePermissions>): CopyProcessingSpec
filesMatching
Link copied to clipboard
abstract fun filesMatching(pattern: String, action: Action<in FileCopyDetails>): CopySpec
open fun filesMatching(pattern: String, action: Action<in FileCopyDetails>): AbstractCopyTask
filesNotMatching
Link copied to clipboard
abstract fun filesNotMatching(pattern: String, action: Action<in FileCopyDetails>): CopySpec
open fun filesNotMatching(pattern: String, action: Action<in FileCopyDetails>): AbstractCopyTask
filter
Link copied to clipboard
abstract fun filter(properties: Map<String, out Any>, filterType: Class<out FilterReader>): ContentFilterable
abstract fun filter(properties: Map<String, out Any>, filterType: Class<out FilterReader>): CopySpec
open fun filter(properties: Map<String, out Any>, filterType: Class<out FilterReader>): AbstractCopyTask
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.

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

Adds a content filter to be used during the copy.

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

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

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

Kotlin extension function taking kotlin.reflect.KClass for org.gradle.api.tasks.AbstractCopyTask.filter.

finalizedBy
Link copied to clipboard
open fun finalizedBy(paths: Array<Any>): Task
from
Link copied to clipboard
abstract fun from(sourcePaths: Array<Any>): CopySourceSpec
abstract fun from(sourcePaths: Array<Any>): CopySpec
open fun from(sourcePaths: Array<Any>): AbstractCopyTask
getActions
Link copied to clipboard
open fun getActions(): List<Action<in Task>>
getAnt
Link copied to clipboard
open fun getAnt(): AntBuilder
getArchiveFile
Link copied to clipboard
open fun getArchiveFile(): Provider<RegularFile>
getArchiveFileName
Link copied to clipboard
open fun getArchiveFileName(): Property<String>
getArchivePath
Link copied to clipboard
open fun getArchivePath(): File
getAsDynamicObject
Link copied to clipboard
open fun getAsDynamicObject(): DynamicObject
getConvention
Link copied to clipboard
open fun getConvention(): Convention
getDependsOn
Link copied to clipboard
open fun getDependsOn(): Set<Any>
getDestinationDirectory
Link copied to clipboard
open fun getDestinationDirectory(): DirectoryProperty
getDestroyables
Link copied to clipboard
open fun getDestroyables(): TaskDestroyables
getDidWork
Link copied to clipboard
open fun getDidWork(): Boolean
getDirMode
Link copied to clipboard
open fun getDirMode(): Integer
getDirPermissions
Link copied to clipboard
open fun getDirPermissions(): Property<ConfigurableFilePermissions>
getDuplicatesStrategy
Link copied to clipboard
open fun getDuplicatesStrategy(): DuplicatesStrategy
getExcludes
Link copied to clipboard
open fun getExcludes(): Set<String>
getExtensions
Link copied to clipboard
open fun getExtensions(): ExtensionContainer
getFileMode
Link copied to clipboard
open fun getFileMode(): Integer
getFilePermissions
Link copied to clipboard
open fun getFilePermissions(): Property<ConfigurableFilePermissions>
getFilteringCharset
Link copied to clipboard
open fun getFilteringCharset(): String
getFinalizedBy
Link copied to clipboard
open fun getFinalizedBy(): TaskDependency
getIdentityPath
Link copied to clipboard
open fun getIdentityPath(): Path
getIncludeEmptyDirs
Link copied to clipboard
open fun getIncludeEmptyDirs(): Boolean
getIncludes
Link copied to clipboard
open fun getIncludes(): Set<String>
getInputs
Link copied to clipboard
open fun getInputs(): TaskInputsInternal
abstract fun getInputs(): TaskInputs
getLifecycleDependencies
Link copied to clipboard
open fun getLifecycleDependencies(): TaskDependencyInternal
abstract fun getLifecycleDependencies(): TaskDependency
getLocalState
Link copied to clipboard
open fun getLocalState(): TaskLocalState
getLogger
Link copied to clipboard
open fun getLogger(): Logger
getLogging
Link copied to clipboard
open fun getLogging(): LoggingManager
getMustRunAfter
Link copied to clipboard
open fun getMustRunAfter(): TaskDependency
getName
Link copied to clipboard
open fun getName(): String
getOnlyIf
Link copied to clipboard
open fun getOnlyIf(): Spec<in TaskInternal>
getOutputs
Link copied to clipboard
open fun getOutputs(): TaskOutputsInternal
abstract fun getOutputs(): TaskOutputs
getPath
Link copied to clipboard
open fun getPath(): String
getProject
Link copied to clipboard
open fun getProject(): Project
getReasonNotToTrackState
Link copied to clipboard
open fun getReasonNotToTrackState(): Optional<String>
getReasonTaskIsIncompatibleWithConfigurationCache
Link copied to clipboard
open fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>
getRequiredServices
Link copied to clipboard
open fun getRequiredServices(): TaskRequiredServices
getSharedResources
Link copied to clipboard
open fun getSharedResources(): List<ResourceLock>
abstract fun getSharedResources(): List<out ResourceLock>
getShouldRunAfter
Link copied to clipboard
open fun getShouldRunAfter(): TaskDependency
getSource
Link copied to clipboard
open fun getSource(): FileCollection
getStandardOutputCapture
Link copied to clipboard
open fun getStandardOutputCapture(): StandardOutputCapture
getState
Link copied to clipboard
abstract fun getState(): TaskState
getTaskActions
Link copied to clipboard
open fun getTaskActions(): List<InputChangesAwareTaskAction>
getTaskDependencies
Link copied to clipboard
open fun getTaskDependencies(): TaskDependencyInternal
abstract fun getTaskDependencies(): TaskDependency
getTaskIdentity
Link copied to clipboard
open fun getTaskIdentity(): TaskIdentity<out Any>
getTemporaryDir
Link copied to clipboard
open fun getTemporaryDir(): File
getTemporaryDirFactory
Link copied to clipboard
open fun getTemporaryDirFactory(): Factory<File>
hasProperty
Link copied to clipboard
open fun hasProperty(propertyName: String): Boolean
hasTaskActions
Link copied to clipboard
open fun hasTaskActions(): Boolean
include
Link copied to clipboard
abstract fun include(includes: Array<String>): CopySpec
open fun include(includes: Array<String>): AbstractCopyTask
abstract fun include(includes: Array<String>): PatternFilterable
injectIntoNewInstance
Link copied to clipboard
open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T
into
Link copied to clipboard
abstract fun into(destPath: Any): CopyProcessingSpec
open fun into(destDir: Any): AbstractCopyTask
open fun into(destPath: Any): AbstractArchiveTask
open fun into(destPath: Any, copySpec: Action<in CopySpec>): CopySpec
isCaseSensitive
Link copied to clipboard
open fun isCaseSensitive(): Boolean
isCompatibleWithConfigurationCache
Link copied to clipboard
open fun isCompatibleWithConfigurationCache(): Boolean
isEnabled
Link copied to clipboard
open fun isEnabled(): Boolean
isHasCustomActions
Link copied to clipboard
open fun isHasCustomActions(): Boolean
isPreserveFileTimestamps
Link copied to clipboard
open fun isPreserveFileTimestamps(): Boolean
isReproducibleFileOrder
Link copied to clipboard
open fun isReproducibleFileOrder(): Boolean
mustRunAfter
Link copied to clipboard
open fun mustRunAfter(paths: Array<Any>): Task
notCompatibleWithConfigurationCache
Link copied to clipboard
open fun notCompatibleWithConfigurationCache(reason: String)
onlyIf
Link copied to clipboard
open fun onlyIf(spec: Spec<in Task>)
prependParallelSafeAction
Link copied to clipboard
open fun prependParallelSafeAction(action: Action<in Task>)
property
Link copied to clipboard
open fun property(propertyName: String): Any
rename
Link copied to clipboard
abstract fun rename(closure: Closure): CopySpec
abstract fun rename(sourceRegEx: Pattern, replaceWith: String): CopyProcessingSpec
open fun rename(closure: Closure): AbstractCopyTask
setActions
Link copied to clipboard
open fun setActions(replacements: List<Action<in Task>>)
setCaseSensitive
Link copied to clipboard
open fun setCaseSensitive(caseSensitive: Boolean)
setDependsOn
Link copied to clipboard
open fun setDependsOn(dependsOn: Iterable<out Any>)
setDidWork
Link copied to clipboard
open fun setDidWork(didWork: Boolean)
setDirMode
Link copied to clipboard
abstract fun setDirMode(mode: Integer): CopyProcessingSpec
open fun setDirMode(mode: Integer): AbstractCopyTask
setDuplicatesStrategy
Link copied to clipboard
open fun setDuplicatesStrategy(strategy: DuplicatesStrategy)
setExcludes
Link copied to clipboard
abstract fun setExcludes(excludes: Iterable<String>): CopySpec
open fun setExcludes(excludes: Iterable<String>): AbstractCopyTask
abstract fun setExcludes(excludes: Iterable<String>): PatternFilterable
setFileMode
Link copied to clipboard
abstract fun setFileMode(mode: Integer): CopyProcessingSpec
open fun setFileMode(mode: Integer): AbstractCopyTask
setFilteringCharset
Link copied to clipboard
open fun setFilteringCharset(charset: String)
setFinalizedBy
Link copied to clipboard
open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)
setIncludeEmptyDirs
Link copied to clipboard
open fun setIncludeEmptyDirs(includeEmptyDirs: Boolean)
setIncludes
Link copied to clipboard
abstract fun setIncludes(includes: Iterable<String>): CopySpec
open fun setIncludes(includes: Iterable<String>): AbstractCopyTask
abstract fun setIncludes(includes: Iterable<String>): PatternFilterable
setMustRunAfter
Link copied to clipboard
open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)
setOnlyIf
Link copied to clipboard
open fun setOnlyIf(spec: Spec<in Task>)
setPreserveFileTimestamps
Link copied to clipboard
open fun setPreserveFileTimestamps(preserveFileTimestamps: Boolean)
setProperty
Link copied to clipboard
open fun setProperty(name: String, value: Any)
setReproducibleFileOrder
Link copied to clipboard
open fun setReproducibleFileOrder(reproducibleFileOrder: Boolean)
setShouldRunAfter
Link copied to clipboard
open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)
shouldRunAfter
Link copied to clipboard
open fun shouldRunAfter(paths: Array<Any>): TaskDependency
the
Link copied to clipboard
inline fun <T : Any> ExtensionAware. the(): T

Returns the extension of the specified type.

fun <T : Any> ExtensionAware. the(extensionType: KClass<T>): T

Returns the extension of the specified extensionType.

usesService
Link copied to clipboard
open fun usesService(service: Provider<out BuildService<out Any>>)
with
Link copied to clipboard
open fun with(sourceSpecs: Array<CopySpec>): CopySpec