gradle/org.gradle.api.tasks.bundling/AbstractArchiveTask

AbstractArchiveTask

@DisableCachingByDefault(because = "Abstract super-class, not to be instantiated directly")
abstract class AbstractArchiveTask : AbstractCopyTask(source)

AbstractArchiveTask is the base class for all archive tasks.

Inheritors

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
@get:Internal(value = "Represented as part of archiveFile")
val archiveAppendix: Property<String>
Link copied to clipboard
@get:Internal(value = "Represented as part of archiveFile")
val archiveBaseName: Property<String>
Link copied to clipboard
@get:Internal(value = "Represented as part of archiveFile")
val archiveClassifier: Property<String>
Link copied to clipboard
@get:Internal(value = "Represented as part of archiveFile")
val archiveExtension: Property<String>
Link copied to clipboard
@get:Internal(value = "Represented as part of archiveFile")
val archiveVersion: Property<String>
Link copied to clipboard
open val conventionMapping: ConventionMapping
Link copied to clipboard
open var description: String
Link copied to clipboard
open var enabled: Boolean
Link copied to clipboard
val ExtensionAware.extra: ExtraPropertiesExtension

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

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

Functions

Link copied to clipboard
open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)
Link copied to clipboard
open fun appendParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open fun compareTo(otherTask: Task): Int
Link copied to clipboard
open fun configure(closure: Closure): Task
abstract fun configure(cl: Closure): T
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.

Link copied to clipboard
open fun conventionMapping(property: String, mapping: Callable<out Any>): Task
Link copied to clipboard
open fun dependsOn(paths: Array<Any>): Task
Link copied to clipboard
Link copied to clipboard
open fun doFirst(action: Action<in Task>): Task
Link copied to clipboard
open fun doLast(action: Action<in Task>): Task
Link copied to clipboard
open fun doNotTrackState(reasonNotToTrackState: String)
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
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
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
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.

Link copied to clipboard
Link copied to clipboard
abstract fun filesMatching(pattern: String, action: Action<in FileCopyDetails>): CopySpec
open fun filesMatching(pattern: String, action: Action<in FileCopyDetails>): AbstractCopyTask
Link copied to clipboard
abstract fun filesNotMatching(pattern: String, action: Action<in FileCopyDetails>): CopySpec
open fun filesNotMatching(pattern: String, action: Action<in FileCopyDetails>): AbstractCopyTask
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
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.

Link copied to clipboard
open fun finalizedBy(paths: Array<Any>): Task
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
Link copied to clipboard
open fun getActions(): List<Action<in Task>>
Link copied to clipboard
open fun getAnt(): AntBuilder
Link copied to clipboard
@OutputFile
open fun getArchiveFile(): Provider<RegularFile>
The RegularFile where the archive is constructed.
Link copied to clipboard
@Internal(value = "Represented as part of archiveFile")
open fun getArchiveFileName(): Property<String>
Returns the archive name.
Link copied to clipboard
@ReplacedBy(value = "archiveFile")
open fun getArchivePath(): File
The path where the archive is constructed.
Link copied to clipboard
open fun getAsDynamicObject(): DynamicObject
Link copied to clipboard
open fun getConvention(): Convention
Link copied to clipboard
open fun getDependsOn(): Set<Any>
Link copied to clipboard
@Internal(value = "Represented by the archiveFile")
open fun getDestinationDirectory(): DirectoryProperty
The directory where the archive will be placed.
Link copied to clipboard
Link copied to clipboard
open fun getDidWork(): Boolean
Link copied to clipboard
open fun getDirMode(): Integer
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open fun getExcludes(): Set<String>
Link copied to clipboard
Link copied to clipboard
open fun getFileMode(): Integer
Link copied to clipboard
Link copied to clipboard
open fun getFilteringCharset(): String
Link copied to clipboard
open fun getFinalizedBy(): TaskDependency
Link copied to clipboard
open fun getIdentityPath(): Path
Link copied to clipboard
open fun getIncludeEmptyDirs(): Boolean
Link copied to clipboard
open fun getIncludes(): Set<String>
Link copied to clipboard
open fun getInputs(): TaskInputsInternal
abstract fun getInputs(): TaskInputs
Link copied to clipboard
open fun getLifecycleDependencies(): TaskDependencyInternal
abstract fun getLifecycleDependencies(): TaskDependency
Link copied to clipboard
open fun getLocalState(): TaskLocalState
Link copied to clipboard
open fun getLogger(): Logger
Link copied to clipboard
open fun getLogging(): LoggingManager
Link copied to clipboard
Link copied to clipboard
open fun getName(): String
Link copied to clipboard
open fun getOnlyIf(): Spec<in TaskInternal>
Link copied to clipboard
open fun getOutputs(): TaskOutputsInternal
abstract fun getOutputs(): TaskOutputs
Link copied to clipboard
open fun getPath(): String
Link copied to clipboard
open fun getProject(): Project
Link copied to clipboard
Link copied to clipboard
open fun getRequiredServices(): TaskRequiredServices
Link copied to clipboard
open fun getSharedResources(): List<ResourceLock>
abstract fun getSharedResources(): List<out ResourceLock>
Link copied to clipboard
Link copied to clipboard
open fun getSource(): FileCollection
Link copied to clipboard
open fun getStandardOutputCapture(): StandardOutputCapture
Link copied to clipboard
abstract fun getState(): TaskState
Link copied to clipboard
open fun getTaskActions(): List<InputChangesAwareTaskAction>
Link copied to clipboard
open fun getTaskDependencies(): TaskDependencyInternal
abstract fun getTaskDependencies(): TaskDependency
Link copied to clipboard
open fun getTaskIdentity(): TaskIdentity<out Any>
Link copied to clipboard
open fun getTemporaryDir(): File
Link copied to clipboard
open fun getTemporaryDirFactory(): Factory<File>
Link copied to clipboard
open fun hasProperty(propertyName: String): Boolean
Link copied to clipboard
open fun hasTaskActions(): Boolean
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
Link copied to clipboard
open fun <T : Task?> injectIntoNewInstance(project: ProjectInternal, identity: TaskIdentity<T>, factory: Callable<T>): T
Link copied to clipboard
abstract fun into(destPath: Any): CopyProcessingSpec

open fun into(destPath: Any): AbstractArchiveTask
Specifies the destination directory *inside* the archive for the files.
open fun into(destPath: Any, configureClosure: Closure): AbstractArchiveTask
open fun into(destPath: Any, copySpec: Action<in CopySpec>): CopySpec
Creates and configures a child CopySpec with a destination directory *inside* the archive for the files.
Link copied to clipboard
open fun isCaseSensitive(): Boolean
Link copied to clipboard
Link copied to clipboard
open fun isEnabled(): Boolean
Link copied to clipboard
open fun isHasCustomActions(): Boolean
Link copied to clipboard
@Input
open fun isPreserveFileTimestamps(): Boolean
Specifies whether file timestamps should be preserved in the archive.
Link copied to clipboard
@Input
open fun isReproducibleFileOrder(): Boolean
Specifies whether to enforce a reproducible file order when reading files from directories.
Link copied to clipboard
open fun mustRunAfter(paths: Array<Any>): Task
Link copied to clipboard
Link copied to clipboard
open fun onlyIf(spec: Spec<in Task>)
Link copied to clipboard
open fun prependParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open fun property(propertyName: String): Any
Link copied to clipboard
abstract fun rename(closure: Closure): CopySpec
abstract fun rename(sourceRegEx: Pattern, replaceWith: String): CopyProcessingSpec
open fun rename(closure: Closure): AbstractCopyTask
Link copied to clipboard
open fun setActions(replacements: List<Action<in Task>>)
Link copied to clipboard
open fun setCaseSensitive(caseSensitive: Boolean)
Link copied to clipboard
open fun setDependsOn(dependsOn: Iterable<out Any>)
Link copied to clipboard
open fun setDidWork(didWork: Boolean)
Link copied to clipboard
abstract fun setDirMode(mode: Integer): CopyProcessingSpec
open fun setDirMode(mode: Integer): AbstractCopyTask
Link copied to clipboard
open fun setDuplicatesStrategy(strategy: DuplicatesStrategy)
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
Link copied to clipboard
abstract fun setFileMode(mode: Integer): CopyProcessingSpec
open fun setFileMode(mode: Integer): AbstractCopyTask
Link copied to clipboard
open fun setFilteringCharset(charset: String)
Link copied to clipboard
open fun setFinalizedBy(finalizedByTasks: Iterable<out Any>)
Link copied to clipboard
open fun setIncludeEmptyDirs(includeEmptyDirs: Boolean)
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
Link copied to clipboard
open fun setMustRunAfter(mustRunAfterTasks: Iterable<out Any>)
Link copied to clipboard
open fun setOnlyIf(spec: Spec<in Task>)
Link copied to clipboard
open fun setPreserveFileTimestamps(preserveFileTimestamps: Boolean)
Specifies whether file timestamps should be preserved in the archive.
Link copied to clipboard
open fun setProperty(name: String, value: Any)
Link copied to clipboard
open fun setReproducibleFileOrder(reproducibleFileOrder: Boolean)
Specifies whether to enforce a reproducible file order when reading files from directories.
Link copied to clipboard
open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<out Any>)
Link copied to clipboard
open fun shouldRunAfter(paths: Array<Any>): TaskDependency
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.

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