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

ShadowJar

@CacheableTask

abstract class ShadowJar : Jar

Constructors

ShadowJar

constructor()

Types

Companion

object Companion

Properties

actions

open var actions: List<Action<in Task>>

addMultiReleaseAttribute

@get:Input

open val addMultiReleaseAttribute: Property<Boolean>

Adds the java.util.jar.Attributes.Name.MULTI_RELEASE attribute to the manifest of the shadow JAR if any dependencies contain the attribute.

ant

open val ant: AntBuilder

apiJars

@get:Classpath

open val apiJars: ConfigurableFileCollection

archiveAppendix

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

open val archiveAppendix: Property<String>

archiveBaseName

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

open val archiveBaseName: Property<String>

archiveClassifier

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

open val archiveClassifier: Property<String>

archiveExtension

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

open val archiveExtension: Property<String>

archiveFile

@get:OutputFile

open val archiveFile: Provider<RegularFile>

archiveFileName

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

open val archiveFileName: Property<String>

archiveVersion

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

open val archiveVersion: Property<String>

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

configurations

@get:Classpath

open val configurations: SetProperty<Configuration>

The configurations to include dependencies from.

conventionMapping

@get:Internal

open val conventionMapping: ConventionMapping

dependencyFilter

@get:Input

open val dependencyFilter: Property<DependencyFilter>

dependsOn

open val dependsOn: Set<Any>

description

open var description: @Nullable String?

destinationDirectory

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

open val destinationDirectory: DirectoryProperty

destroyables

open val destroyables: TaskDestroyables

didWork

open var didWork: Boolean

dirPermissions

@get:Internal

open val dirPermissions: Property<ConfigurableFilePermissions>

duplicatesStrategy

open override var duplicatesStrategy: DuplicatesStrategy

enableAutoRelocation

@get:Input

open val enableAutoRelocation: Property<Boolean>

Enables auto relocation of packages in the dependencies.

enabled

open var enabled: Boolean

entryCompression

@get:Input

open var entryCompression: ZipEntryCompression

excludes

@get:Input

open override val excludes: MutableSet<String>

extensions

open val extensions: ExtensionContainer

failOnDuplicateEntries

@get:Input

open val failOnDuplicateEntries: Property<Boolean>

Fails build if the ZIP entries in the shadowed JAR are duplicate.

filePermissions

@get:Internal

open val filePermissions: Property<ConfigurableFilePermissions>

filteringCharset

@get:Internal

open var filteringCharset: String

finalizedBy

open val finalizedBy: TaskDependency

group

open var group: @Nullable String?

identityPath

open val identityPath: Path

impliesSubProjects

open var impliesSubProjects: Boolean

includedDependencies

@get:Classpath

open val includedDependencies: ConfigurableFileCollection

Final dependencies to be shadowed.

includeEmptyDirs

@get:Internal

open var includeEmptyDirs: Boolean

includes

@get:Input

open override val includes: MutableSet<String>

inputs

open val inputs: TaskInputsInternal

isCaseSensitive

@get:Internal

open var isCaseSensitive: Boolean

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

isEnabled

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

isPreserveFileTimestamps

@get:Input

open var isPreserveFileTimestamps: Boolean

isReproducibleFileOrder

@get:Input

open var isReproducibleFileOrder: Boolean

isZip64

@get:Input

open var isZip64: Boolean

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal

localState

open val localState: TaskLocalState

logger

open val logger: Logger

logging

open val logging: LoggingManager

mainClass

@get:Optional

@get:Input

open val mainClass: Property<String>

Main class attribute to add to manifest.

manifest

@get:Internal

open override var manifest: InheritManifest

manifestContentCharset

@get:Input

open var manifestContentCharset: String?

metadataCharset

open val metadataCharset: String?

metaInf

@get:Internal

open val metaInf: CopySpec?

minimizeJar

@get:Input

open val minimizeJar: Property<Boolean>

Minimizes the jar by removing unused classes.

mustRunAfter

open val mustRunAfter: TaskDependency

name

open val name: String

onlyIf

open val onlyIf: Spec<in TaskInternal>

outputs

open val outputs: TaskOutputsInternal

path

open val path: String

project

open val project: Project

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String>

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String>

relocationPrefix

@get:Input

open val relocationPrefix: Property<String>

Prefix used for auto relocation of packages in the dependencies.

relocators

open val relocators: SetProperty<Relocator>

Relocators to be applied in the shadow steps.

requiredServices

open val requiredServices: TaskRequiredServices

rootSpec

@get:Internal

open val rootSpec: CopySpecInternal

sharedResources

open val sharedResources: List<ResourceLock>

shouldRunAfter

open val shouldRunAfter: TaskDependency

source

@get:Internal

open val source: FileCollection

sourceSetsClassesDirs

@get:InputFiles

@get:PathSensitive(value = PathSensitivity.RELATIVE)

open val sourceSetsClassesDirs: ConfigurableFileCollection

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture

state

open val state: TaskStateInternal

taskActions

open val taskActions: List<InputChangesAwareTaskAction>

taskDependencies

open val taskDependencies: TaskDependencyInternal

taskIdentity

open val taskIdentity: TaskIdentity<*>

temporaryDir

open val temporaryDir: File

temporaryDirFactory

open val temporaryDirFactory: Factory<File>

timeout

open val timeout: Property<Duration>

toMinimize

@get:Classpath

open val toMinimize: ConfigurableFileCollection

transformers

open val transformers: SetProperty<ResourceTransformer>

ResourceTransformers to be applied in the shadow steps.

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

append

@JvmOverloads

open fun append(resourcePath: String, separator: String = AppendingTransformer.DEFAULT_SEPARATOR)

Append contents to a resource in the jar.

appendParallelSafeAction

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

compareTo

open operator fun compareTo(otherTask: Task): Int

configure

open fun configure(closure: Closure<*>): Task

conventionMapping

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

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

dependencies

open fun dependencies(action: Action<DependencyFilter>)

Extra dependency operations to be applied in the shadow steps.

dependsOn

open fun dependsOn(vararg paths: Any): Task

dirPermissions

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

doFirst

open fun doFirst(action: Closure<*>): Task

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

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

doLast

open fun doLast(action: Closure<*>): Task

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

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

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

eachFile

open fun eachFile(closure: Closure<*>): AbstractCopyTask

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

exclude

open fun exclude(excludeSpec: Closure<*>): AbstractCopyTask

open fun exclude(vararg excludes: String): AbstractCopyTask

open fun exclude(excludes: Iterable<String>): AbstractCopyTask

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

expand

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

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

filePermissions

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

filesMatching

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

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

filesNotMatching

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

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

filter

open fun filter(closure: Closure<*>): AbstractCopyTask

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

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

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

finalizedBy

open fun finalizedBy(vararg paths: Any): Task

from

open fun from(vararg sourcePaths: @Nullable Any?): AbstractCopyTask

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

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

getDuplicatesStrategy

open override fun getDuplicatesStrategy(): DuplicatesStrategy

Returns the strategy to use when trying to copy more than one file to the same destination.

getExcludes

@Input

open override fun getExcludes(): MutableSet<String>

getIncludes

@Input

open override fun getIncludes(): MutableSet<String>

getManifest

@Internal

open override fun getManifest(): InheritManifest

hasProperty

open fun hasProperty(propertyName: String): Boolean

hasTaskActions

open fun hasTaskActions(): Boolean

include

open fun include(includeSpec: Closure<*>): AbstractCopyTask

open fun include(vararg includes: String): AbstractCopyTask

open fun include(includes: Iterable<String>): AbstractCopyTask

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

into

open fun into(destPath: Any): AbstractArchiveTask

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

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

manifest

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

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

mergeGroovyExtensionModules

open fun mergeGroovyExtensionModules()

Merge Groovy extension modules (META-INF/**/org.codehaus.groovy.runtime.ExtensionModule).

mergeServiceFiles

open fun mergeServiceFiles(rootPath: String)

Merge Java services files with rootPath.

@JvmOverloads

open fun mergeServiceFiles(action: Action<ServiceFileTransformer> = Action {})

Merge Java services files with action.

metaInf

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

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

minimize

@JvmOverloads

open fun minimize(action: Action<DependencyFilter> = Action {})

Enable minimizeJar and execute the action with the DependencyFilter for minimize.

mustRunAfter

open fun mustRunAfter(vararg paths: Any): Task

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

onlyIf

open fun onlyIf(onlyIfClosure: Closure<*>)

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

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

prependParallelSafeAction

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

property

open fun property(propertyName: String): Any

relocate

inline fun <R : Relocator> relocate(action: Action<R> = Action {})

@JvmOverloads

open fun <R : Relocator> relocate(relocator: R, action: Action<R> = Action {})

@JvmOverloads

open fun <R : Relocator> relocate(clazz: Class<R>, action: Action<R> = Action {})

Relocate classes and resources using a Relocator.

@JvmOverloads

open fun relocate(pattern: String, destination: String, action: Action<SimpleRelocator> = Action {})

Relocate classes and resources matching pattern to destination using SimpleRelocator.

rename

open fun rename(closure: Closure<*>): AbstractCopyTask

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

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

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

setDependsOn

open fun setDependsOn(dependsOn: Iterable<*>)

setExcludes

open fun setExcludes(excludes: Iterable<String>): AbstractCopyTask

setFinalizedBy

open fun setFinalizedBy(finalizedByTasks: Iterable<*>)

setIncludes

open fun setIncludes(includes: Iterable<String>): AbstractCopyTask

setMetadataCharset

open fun setMetadataCharset(metadataCharset: String)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>)

setOnlyIf

open fun setOnlyIf(onlyIfClosure: Closure<*>)

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

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

setProperty

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

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>)

shouldRunAfter

open fun shouldRunAfter(vararg paths: Any): TaskDependency

transform

inline fun <T : ResourceTransformer> transform(action: Action<T> = Action {})

@JvmOverloads

open fun <T : ResourceTransformer> transform(transformer: T, action: Action<T> = Action {})

@JvmOverloads

open fun <T : ResourceTransformer> transform(clazz: Class<T>, action: Action<T> = Action {})

Transform resources using a ResourceTransformer.

useFileSystemPermissions

@Incubating

open fun useFileSystemPermissions()

usesService

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

with

open fun with(vararg sourceSpecs: CopySpec): CopySpec