shadow/com.github.jengelman.gradle.plugins.shadow.tasks/ShadowJar

ShadowJar

@CacheableTask

abstract class ShadowJar : Jar, ShadowSpec

Constructors

ShadowJar

constructor()

Properties

apiJars

@get:Classpath

open val apiJars: ConfigurableFileCollection

archiveAppendix

@get:Internal(value = "Represented as part of archiveFile")

val archiveAppendix: Property<String>

archiveBaseName

@get:Internal(value = "Represented as part of archiveFile")

val archiveBaseName: Property<String>

archiveClassifier

@get:Internal(value = "Represented as part of archiveFile")

val archiveClassifier: Property<String>

archiveExtension

@get:Internal(value = "Represented as part of archiveFile")

val archiveExtension: Property<String>

archiveVersion

@get:Internal(value = "Represented as part of archiveFile")

val archiveVersion: Property<String>

configurations

@get:Classpath

@get:Optional

open val configurations: SetProperty<Configuration>

conventionMapping

@get:Internal

val conventionMapping: ConventionMapping

dependencyFilter

@get:Input

open val dependencyFilter: Property<DependencyFilter>

enabled

@get:Internal

var enabled: Boolean

enableRelocation

@get:Input

open val enableRelocation: Property<Boolean>

Enable relocation of packages in the jar.

entryCompression

@get:Input

var entryCompression: ZipEntryCompression

hasCustomActions

val hasCustomActions: Boolean

impliesSubProjects

var impliesSubProjects: Boolean

includedDependencies

@get:Classpath

open val includedDependencies: ConfigurableFileCollection

manifestContentCharset

@get:Input

var manifestContentCharset: String

minimizeJar

@get:Input

open val minimizeJar: Property<Boolean>

Minimize the jar by removing unused classes.

relocationPrefix

@get:Input

open val relocationPrefix: Property<String>

Prefix to use for relocated packages.

relocators

open val relocators: SetProperty<Relocator>

rootSpec

@get:Internal

val rootSpec: CopySpecInternal

sourceSetsClassesDirs

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

open val sourceSetsClassesDirs: ConfigurableFileCollection

state

val state: TaskStateInternal

timeout

val timeout: Property<Duration>

toMinimize

@get:Classpath

open val toMinimize: ConfigurableFileCollection

transformers

open val transformers: SetProperty<Transformer>

Functions

acceptServiceReferences

open override fun acceptServiceReferences(serviceReferences: MutableSet<ServiceReferenceSpec>)

append

open override fun append(resourcePath: String): ShadowJar

open override fun append(resourcePath: String, separator: String): ShadowJar

Append contents to a resource in the jar.

appendParallelSafeAction

open override fun appendParallelSafeAction(action: Action<in Task>)

compareTo

open operator override fun compareTo(other: Task): Int

configure

open override fun configure(closure: Closure<Any>): Task

conventionMapping

open fun conventionMapping(property: String, mapping: Closure<Any>): Task

open fun conventionMapping(property: String, mapping: Callable<*>): Task

dependencies

open override fun dependencies(action: Action<DependencyFilter>?): ShadowJar

dependsOn

open override fun dependsOn(vararg paths: Any): Task

dirPermissions

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

doFirst

open override fun doFirst(action: Closure<Any>): Task

open override fun doFirst(action: Action<in Task>): Task

open override fun doFirst(actionName: String, action: Action<in Task>): Task

doLast

open override fun doLast(action: Closure<Any>): Task

open override fun doLast(action: Action<in Task>): Task

open override fun doLast(actionName: String, action: Action<in Task>): Task

doNotTrackState

open override fun doNotTrackState(reasonNotToTrackState: String)

eachFile

open override fun eachFile(closure: Closure<Any>): AbstractCopyTask

open override fun eachFile(action: Action<in FileCopyDetails>): AbstractCopyTask

exclude

open override fun exclude(excludeSpec: Closure<Any>): AbstractCopyTask

open override fun exclude(vararg excludes: String): AbstractCopyTask

open override fun exclude(excludes: MutableIterable<String>): AbstractCopyTask

open override fun exclude(excludeSpec: Spec<FileTreeElement>): AbstractCopyTask

expand

open override fun expand(properties: MutableMap<String, *>): AbstractCopyTask

open override fun expand(properties: MutableMap<String, *>, action: Action<in ExpandDetails>): AbstractCopyTask

filePermissions

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

filesMatching

open override fun filesMatching(pattern: String, action: Action<in FileCopyDetails>): AbstractCopyTask

open override fun filesMatching(patterns: MutableIterable<String>, action: Action<in FileCopyDetails>): AbstractCopyTask

filesNotMatching

open override fun filesNotMatching(pattern: String, action: Action<in FileCopyDetails>): AbstractCopyTask

open override fun filesNotMatching(patterns: MutableIterable<String>, action: Action<in FileCopyDetails>): AbstractCopyTask

filter

open override fun filter(closure: Closure<Any>): AbstractCopyTask

open override fun filter(filterType: Class<out FilterReader>): AbstractCopyTask

open override fun filter(transformer: Transformer<@Nullable String, String>): AbstractCopyTask

open override fun filter(properties: MutableMap<String, *>, filterType: Class<out FilterReader>): AbstractCopyTask

finalizedBy

open override fun finalizedBy(vararg paths: Any): Task

from

open override fun from(vararg sourcePaths: Any): AbstractCopyTask

open override fun from(sourcePath: Any, c: Closure<Any>): AbstractCopyTask

open override fun from(sourcePath: Any, configureAction: Action<in CopySpec>): AbstractCopyTask

getActions

open override fun getActions(): MutableList<Action<in Task>>

getAnt

open override fun getAnt(): AntBuilder

getArchiveFile

@OutputFile

open fun getArchiveFile(): Provider<RegularFile>

getArchiveFileName

@Internal(value = "Represented as part of archiveFile")

open fun getArchiveFileName(): Property<String>

getArchivePath

@ReplacedBy(value = "archiveFile")

open fun ~~getArchivePath~~(): File

getAsDynamicObject

@Internal

open override fun getAsDynamicObject(): DynamicObject

getConvention

@Internal

open override fun ~~getConvention~~(): Convention

getDependsOn

open override fun getDependsOn(): MutableSet<Any>

getDescription

open override fun getDescription(): String?

getDestinationDirectory

@Internal(value = "Represented by the archiveFile")

open fun getDestinationDirectory(): DirectoryProperty

getDestroyables

open override fun getDestroyables(): TaskDestroyables

getDidWork

open override fun getDidWork(): Boolean

getDirMode

@Internal

open override fun ~~getDirMode~~(): Int?

getDirPermissions

@Internal

open override fun getDirPermissions(): Property<ConfigurableFilePermissions>

getDuplicatesStrategy

@Internal

open override fun getDuplicatesStrategy(): DuplicatesStrategy

getExcludes

@Input

open override fun getExcludes(): MutableSet<String>

getExtensions

open override fun getExtensions(): ExtensionContainer

getFileMode

@Internal

open override fun ~~getFileMode~~(): Int?

getFilePermissions

@Internal

open override fun getFilePermissions(): Property<ConfigurableFilePermissions>

getFilteringCharset

@Internal

open override fun getFilteringCharset(): String

getFinalizedBy

open override fun getFinalizedBy(): TaskDependency

getGroup

open override fun getGroup(): String?

getIdentityPath

open override fun getIdentityPath(): Path

getIncludeEmptyDirs

@Internal

open override fun getIncludeEmptyDirs(): Boolean

getIncludes

@Input

open override fun getIncludes(): MutableSet<String>

getInputs

open override fun getInputs(): TaskInputsInternal

getLifecycleDependencies

@Internal

open override fun getLifecycleDependencies(): TaskDependencyInternal

getLocalState

open override fun getLocalState(): TaskLocalState

getLogger

open override fun getLogger(): Logger

getLogging

open override fun getLogging(): LoggingManager

getManifest

@Internal

open override fun getManifest(): InheritManifest

getMetadataCharset

open override fun getMetadataCharset(): String?

getMetaInf

@Internal

open fun getMetaInf(): CopySpec

getMustRunAfter

open override fun getMustRunAfter(): TaskDependency

getName

open override fun getName(): String

getOnlyIf

open override fun getOnlyIf(): Spec<in TaskInternal>

getOutputs

open override fun getOutputs(): TaskOutputsInternal

getPath

open override fun getPath(): String

getProject

open override fun getProject(): Project

getReasonNotToTrackState

open override fun getReasonNotToTrackState(): Optional<String>

getReasonTaskIsIncompatibleWithConfigurationCache

open override fun getReasonTaskIsIncompatibleWithConfigurationCache(): Optional<String>

getRequiredServices

open override fun getRequiredServices(): TaskRequiredServices

getSharedResources

open override fun getSharedResources(): MutableList<ResourceLock>

getShouldRunAfter

open override fun getShouldRunAfter(): TaskDependency

getSource

@Internal

open fun getSource(): FileCollection

getStandardOutputCapture

open override fun getStandardOutputCapture(): StandardOutputCapture

getTaskActions

open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction>

getTaskDependencies

open override fun getTaskDependencies(): TaskDependencyInternal

getTaskIdentity

open override fun getTaskIdentity(): TaskIdentity<*>

getTemporaryDir

open override fun getTemporaryDir(): File

getTemporaryDirFactory

open override fun getTemporaryDirFactory(): Factory<File>

hasProperty

open override fun hasProperty(propertyName: String): Boolean

hasTaskActions

open override fun hasTaskActions(): Boolean

include

open override fun include(includeSpec: Closure<Any>): AbstractCopyTask

open override fun include(vararg includes: String): AbstractCopyTask

open override fun include(includes: MutableIterable<String>): AbstractCopyTask

open override fun include(includeSpec: Spec<FileTreeElement>): AbstractCopyTask

into

open override fun into(destPath: Any): AbstractArchiveTask

open override fun into(destPath: Any, configureClosure: Closure<Any>): AbstractArchiveTask

open override fun into(destPath: Any, copySpec: Action<in CopySpec>): CopySpec

isCaseSensitive

@Internal

open override fun isCaseSensitive(): Boolean

isCompatibleWithConfigurationCache

open override fun isCompatibleWithConfigurationCache(): Boolean

isPreserveFileTimestamps

@Input

open fun isPreserveFileTimestamps(): Boolean

isReproducibleFileOrder

@Input

open fun isReproducibleFileOrder(): Boolean

isZip64

@Input

open fun isZip64(): Boolean

manifest

open override fun manifest(configureClosure: Closure<*>): Jar

open fun manifest(configureAction: Action<in Manifest>): Jar

mergeGroovyExtensionModules

open override fun mergeGroovyExtensionModules(): ShadowJar

mergeServiceFiles

open override fun mergeServiceFiles(): ShadowJar

open override fun mergeServiceFiles(rootPath: String): ShadowJar

open override fun mergeServiceFiles(action: Action<ServiceFileTransformer>?): ShadowJar

metaInf

open fun metaInf(@DelegatesTo(value = CopySpec::class) configureClosure: Closure<*>): CopySpec

open fun metaInf(configureAction: Action<in CopySpec>): CopySpec

minimize

open override fun minimize(): ShadowJar

open override fun minimize(action: Action<DependencyFilter>?): ShadowJar

mustRunAfter

open override fun mustRunAfter(vararg paths: Any): Task

notCompatibleWithConfigurationCache

open override fun notCompatibleWithConfigurationCache(reason: String)

onlyIf

open override fun onlyIf(onlyIfClosure: Closure<Any>)

open override fun onlyIf(spec: Spec<in Task>)

open override fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)

prependParallelSafeAction

open override fun prependParallelSafeAction(action: Action<in Task>)

property

open override fun property(propertyName: String): Any?

relocate

open override fun relocate(relocator: Relocator): ShadowJar

open override fun relocate(clazz: Class<Relocator>): ShadowJar

open override fun <R : Relocator> relocate(clazz: Class<R>, action: Action<R>?): ShadowJar

open override fun relocate(pattern: String, destination: String): ShadowJar

open override fun relocate(pattern: String, destination: String, action: Action<SimpleRelocator>?): ShadowJar

rename

open override fun rename(closure: Closure<Any>): AbstractCopyTask

open override fun rename(renamer: Transformer<@Nullable String, String>): AbstractCopyTask

open override fun rename(sourceRegEx: Pattern, replaceWith: String): AbstractCopyTask

open override fun rename(sourceRegEx: String, replaceWith: String): AbstractCopyTask

setActions

open override fun setActions(replacements: MutableList<Action<in Task>>)

setCaseSensitive

open override fun setCaseSensitive(caseSensitive: Boolean)

setDependsOn

open override fun setDependsOn(dependsOn: MutableIterable<*>)

setDescription

open override fun setDescription(description: String?)

setDidWork

open override fun setDidWork(didWork: Boolean)

setDirMode

open override fun ~~setDirMode~~(@Nullable mode: Int?): AbstractCopyTask

setDuplicatesStrategy

open override fun setDuplicatesStrategy(strategy: DuplicatesStrategy)

setExcludes

open override fun setExcludes(excludes: MutableIterable<String>): AbstractCopyTask

setFileMode

open override fun ~~setFileMode~~(@Nullable mode: Int?): AbstractCopyTask

setFilteringCharset

open override fun setFilteringCharset(charset: String)

setFinalizedBy

open override fun setFinalizedBy(finalizedByTasks: MutableIterable<*>)

setGroup

open override fun setGroup(group: String?)

setIncludeEmptyDirs

open override fun setIncludeEmptyDirs(includeEmptyDirs: Boolean)

setIncludes

open override fun setIncludes(includes: MutableIterable<String>): AbstractCopyTask

setManifest

open fun setManifest(manifest: Manifest)

setMetadataCharset

open override fun setMetadataCharset(metadataCharset: String)

setMustRunAfter

open override fun setMustRunAfter(mustRunAfterTasks: MutableIterable<*>)

setOnlyIf

open override fun setOnlyIf(onlyIfClosure: Closure<Any>)

open override fun setOnlyIf(spec: Spec<in Task>)

open override fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)

setPreserveFileTimestamps

open fun setPreserveFileTimestamps(preserveFileTimestamps: Boolean)

setProperty

open override fun setProperty(name: String, value: Any)

setReproducibleFileOrder

open fun setReproducibleFileOrder(reproducibleFileOrder: Boolean)

setShouldRunAfter

open override fun setShouldRunAfter(shouldRunAfterTasks: MutableIterable<*>)

setZip64

open fun setZip64(allowZip64: Boolean)

shouldRunAfter

open override fun shouldRunAfter(vararg paths: Any): TaskDependency

transform

open override fun transform(transformer: Transformer): ShadowJar

open override fun transform(clazz: Class<Transformer>): ShadowJar

open override fun <T : Transformer> transform(clazz: Class<T>, action: Action<T>?): ShadowJar

usesService

open override fun usesService(service: Provider<out BuildService<*>>)

with

open override fun with(vararg sourceSpecs: CopySpec): CopySpec