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

类 ShadowJar

java.lang.Object

org.gradle.api.internal.AbstractTask

org.gradle.api.DefaultTask

org.gradle.api.internal.ConventionTask

org.gradle.api.tasks.AbstractCopyTask

org.gradle.api.tasks.bundling.AbstractArchiveTask

org.gradle.api.tasks.bundling.Zip

org.gradle.jvm.tasks.Jar

org.gradle.api.tasks.bundling.Jar

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

所有已实现的接口:

java.lang.Comparable<org.gradle.api.Task>, org.gradle.api.file.ContentFilterable, org.gradle.api.file.CopyProcessingSpec, org.gradle.api.file.CopySourceSpec, org.gradle.api.file.CopySpec, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.file.copy.CopySpecSource, org.gradle.api.internal.IConventionAware, org.gradle.api.internal.TaskInternal, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.api.tasks.util.PatternFilterable, org.gradle.util.Configurable<org.gradle.api.Task>

@CacheableTask
public class ShadowJar
extends org.gradle.api.tasks.bundling.Jar

嵌套类概要

从接口继承的嵌套类/接口 org.gradle.api.Task

org.gradle.api.Task.Namer

字段概要

从类继承的字段 org.gradle.jvm.tasks.Jar

DEFAULT_EXTENSION

从类继承的字段 org.gradle.api.tasks.bundling.Zip

ZIP_EXTENSION

从接口继承的字段 org.gradle.api.Task

TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

构造器概要

构造器

构造器和说明
ShadowJar()

方法概要

限定符和类型	方法和说明
ShadowJar	append(java.lang.String resourcePath) Syntax sugar for merging service files in JARs
protected void	copy()
protected org.gradle.api.internal.file.copy.CopyAction	createCopyAction()
ShadowJar	dependencies(org.gradle.api.Action<com.github.jengelman.gradle.plugins.shadow.internal.DependencyFilter> c) Configure inclusion/exclusion of module and project dependencies into uber jar.
java.util.List<org.gradle.api.file.FileCollection>	getConfigurations()
com.github.jengelman.gradle.plugins.shadow.internal.DependencyFilter	getDependencyFilter()
java.util.List<java.lang.String>	getIgnoreRelocations()
org.gradle.api.file.FileCollection	getIncludedDependencies()
protected com.github.jengelman.gradle.plugins.shadow.internal.ZipCompressor	getInternalCompressor()
com.github.jengelman.gradle.plugins.shadow.tasks.InheritManifest	getManifest()
java.util.List<com.github.jengelman.gradle.plugins.shadow.relocation.Relocator>	getRelocators()
protected org.gradle.api.tasks.util.PatternSet	getRootPatternSet() Utility method for assisting between changes in Gradle 1.12 and 2.x.
com.github.jengelman.gradle.plugins.shadow.ShadowStats	getStats()
java.util.List<com.github.jengelman.gradle.plugins.shadow.transformers.Transformer>	getTransformers()
ShadowJar	ignoreRelocations(java.util.List<java.lang.String> files)
ShadowJar	ignoreRelocations(java.lang.String... files)
ShadowJar	mergeGroovyExtensionModules() Syntactic sugar for merging Groovy extension module descriptor files in JARs
ShadowJar	mergeServiceFiles() Syntactic sugar for merging service files in JARs.
ShadowJar	mergeServiceFiles(org.gradle.api.Action<com.github.jengelman.gradle.plugins.shadow.transformers.ServiceFileTransformer> configureClosure) Syntactic sugar for merging service files in JARs.
ShadowJar	mergeServiceFiles(java.lang.String rootPath) Syntactic sugar for merging service files in JARs.
ShadowJar	minimize()
ShadowJar	minimize(org.gradle.api.Action<com.github.jengelman.gradle.plugins.shadow.internal.DependencyFilter> c)
ShadowJar	relocate(java.lang.Class<? extends com.github.jengelman.gradle.plugins.shadow.relocation.Relocator> relocatorClass) Add a relocator of the provided class.
<R extends com.github.jengelman.gradle.plugins.shadow.relocation.Relocator> ShadowJar	relocate(java.lang.Class<R> relocatorClass, org.gradle.api.Action<R> configure) Add a relocator of the provided class and configure.
ShadowJar	relocate(com.github.jengelman.gradle.plugins.shadow.relocation.Relocator relocator) Add a relocator instance.
ShadowJar	relocate(java.lang.String pattern, java.lang.String destination) Add a class relocator that maps each class in the pattern to the provided destination.
ShadowJar	relocate(java.lang.String pattern, java.lang.String destination, org.gradle.api.Action<com.github.jengelman.gradle.plugins.shadow.relocation.SimpleRelocator> configure) Add a class relocator that maps each class in the pattern to the provided destination.
void	setConfigurations(java.util.List<org.gradle.api.file.FileCollection> configurations)
void	setDependencyFilter(com.github.jengelman.gradle.plugins.shadow.internal.DependencyFilter filter)
ShadowJar	setIgnoreRelocations(java.util.List<java.lang.String> ignoreRelocations)
void	setRelocators(java.util.List<com.github.jengelman.gradle.plugins.shadow.relocation.Relocator> relocators)
void	setTransformers(java.util.List<com.github.jengelman.gradle.plugins.shadow.transformers.Transformer> transformers)
ShadowJar	transform(java.lang.Class<? extends com.github.jengelman.gradle.plugins.shadow.transformers.Transformer> clazz) Add a Transformer instance for modifying JAR resources and configure.
<T extends com.github.jengelman.gradle.plugins.shadow.transformers.Transformer> ShadowJar	transform(java.lang.Class<T> clazz, org.gradle.api.Action<T> c) Add a Transformer instance for modifying JAR resources and configure.
ShadowJar	transform(com.github.jengelman.gradle.plugins.shadow.transformers.Transformer transformer) Add a preconfigured transformer instance.

从类继承的方法 org.gradle.api.tasks.bundling.Jar

manifest

从类继承的方法 org.gradle.jvm.tasks.Jar

getManifestContentCharset, getMetadataCharset, getMetaInf, manifest, metaInf, metaInf, setManifest, setManifestContentCharset, setMetadataCharset

从类继承的方法 org.gradle.api.tasks.bundling.Zip

getCompressor, getEntryCompression, isZip64, setEntryCompression, setZip64

从类继承的方法 org.gradle.api.tasks.bundling.AbstractArchiveTask

createCopyActionExecuter, getAppendix, getArchiveAppendix, getArchiveBaseName, getArchiveClassifier, getArchiveExtension, getArchiveFile, getArchiveFileName, getArchiveName, getArchivePath, getArchiveVersion, getBaseName, getClassifier, getDestinationDir, getDestinationDirectory, getExtension, getVersion, into, into, into, isPreserveFileTimestamps, isReproducibleFileOrder, setAppendix, setArchiveName, setBaseName, setClassifier, setDestinationDir, setExtension, setPreserveFileTimestamps, setReproducibleFileOrder, setVersion

从类继承的方法 org.gradle.api.tasks.AbstractCopyTask

createRootSpec, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirectoryFileTreeFactory, getDirMode, getDocumentationRegistry, getDuplicatesStrategy, getExcludes, getFileLookup, getFileMode, getFileResolver, getFileSystem, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getRootSpec, getSource, include, include, include, include, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDirMode, setDuplicatesStrategy, setExcludes, setFileMode, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with

从类继承的方法 org.gradle.api.internal.ConventionTask

conventionMapping, conventionMapping, getConventionMapping

从类继承的方法 org.gradle.api.DefaultTask

compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

从类继承的方法 org.gradle.api.internal.AbstractTask

appendParallelSafeAction, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getOnlyIf, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isEnabled, isHasCustomActions, prependParallelSafeAction, setImpliesSubProjects

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.gradle.api.file.CopySpec

eachFile, eachFile, exclude, exclude, exclude, exclude, expand, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDuplicatesStrategy, getFilteringCharset, getIncludeEmptyDirs, include, include, include, include, into, into, into, isCaseSensitive, rename, rename, rename, rename, setCaseSensitive, setDuplicatesStrategy, setExcludes, setFilteringCharset, setIncludeEmptyDirs, setIncludes, with

从接口继承的方法 org.gradle.api.file.CopyProcessingSpec

getDirMode, getFileMode, setDirMode, setFileMode

从接口继承的方法 org.gradle.api.tasks.util.PatternFilterable

getExcludes, getIncludes

从接口继承的方法 org.gradle.api.Task

getConvention

构造器详细资料

ShadowJar

public ShadowJar()

方法详细资料

minimize

public ShadowJar minimize()

minimize

public ShadowJar minimize(org.gradle.api.Action<com.github.jengelman.gradle.plugins.shadow.internal.DependencyFilter> c)

getStats

@Internal
public com.github.jengelman.gradle.plugins.shadow.ShadowStats getStats()

getManifest

public com.github.jengelman.gradle.plugins.shadow.tasks.InheritManifest getManifest()

覆盖:

getManifest 在类中 org.gradle.jvm.tasks.Jar

createCopyAction

protected org.gradle.api.internal.file.copy.CopyAction createCopyAction()

覆盖:

createCopyAction 在类中 org.gradle.api.tasks.bundling.Zip

getInternalCompressor

@Internal
protected com.github.jengelman.gradle.plugins.shadow.internal.ZipCompressor getInternalCompressor()

copy

protected void copy()

覆盖:

copy 在类中 org.gradle.api.tasks.AbstractCopyTask

getIncludedDependencies

@Classpath
public org.gradle.api.file.FileCollection getIncludedDependencies()

getRootPatternSet

@Internal
protected org.gradle.api.tasks.util.PatternSet getRootPatternSet()

Utility method for assisting between changes in Gradle 1.12 and 2.x.

返回:

this

dependencies

public ShadowJar dependencies(org.gradle.api.Action<com.github.jengelman.gradle.plugins.shadow.internal.DependencyFilter> c)

Configure inclusion/exclusion of module and project dependencies into uber jar.

参数:

c - the configuration of the filter

返回:

this

transform

public ShadowJar transform(java.lang.Class<? extends com.github.jengelman.gradle.plugins.shadow.transformers.Transformer> clazz)
                    throws java.lang.InstantiationException,
                           java.lang.IllegalAccessException,
                           java.lang.NoSuchMethodException,
                           java.lang.reflect.InvocationTargetException

Add a Transformer instance for modifying JAR resources and configure.

参数:

clazz - the transformer to add. Must have a no-arg constructor

返回:

this

抛出:

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.NoSuchMethodException

java.lang.reflect.InvocationTargetException

transform

public <T extends com.github.jengelman.gradle.plugins.shadow.transformers.Transformer> ShadowJar transform(java.lang.Class<T> clazz,
                                                                                                           org.gradle.api.Action<T> c)
                                                                                                    throws java.lang.InstantiationException,
                                                                                                           java.lang.IllegalAccessException,
                                                                                                           java.lang.NoSuchMethodException,
                                                                                                           java.lang.reflect.InvocationTargetException

Add a Transformer instance for modifying JAR resources and configure.

参数:

clazz - the transformer class to add. Must have no-arg constructor

c - the configuration for the transformer

返回:

this

抛出:

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.NoSuchMethodException

java.lang.reflect.InvocationTargetException

transform

public ShadowJar transform(com.github.jengelman.gradle.plugins.shadow.transformers.Transformer transformer)

Add a preconfigured transformer instance.

参数:

transformer - the transformer instance to add

返回:

this

mergeServiceFiles

public ShadowJar mergeServiceFiles()

Syntactic sugar for merging service files in JARs.

返回:

this

mergeServiceFiles

public ShadowJar mergeServiceFiles(java.lang.String rootPath)

Syntactic sugar for merging service files in JARs.

返回:

this

mergeServiceFiles

public ShadowJar mergeServiceFiles(org.gradle.api.Action<com.github.jengelman.gradle.plugins.shadow.transformers.ServiceFileTransformer> configureClosure)

Syntactic sugar for merging service files in JARs.

返回:

this

mergeGroovyExtensionModules

public ShadowJar mergeGroovyExtensionModules()

Syntactic sugar for merging Groovy extension module descriptor files in JARs

返回:

this

append

public ShadowJar append(java.lang.String resourcePath)

Syntax sugar for merging service files in JARs

返回:

this

getIgnoreRelocations

public java.util.List<java.lang.String> getIgnoreRelocations()

setIgnoreRelocations

public ShadowJar setIgnoreRelocations(java.util.List<java.lang.String> ignoreRelocations)

ignoreRelocations

public ShadowJar ignoreRelocations(java.util.List<java.lang.String> files)

ignoreRelocations

public ShadowJar ignoreRelocations(java.lang.String... files)

relocate

public ShadowJar relocate(java.lang.String pattern,
                          java.lang.String destination)

Add a class relocator that maps each class in the pattern to the provided destination.

参数:

pattern - the source pattern to relocate

destination - the destination package

返回:

this

relocate

public ShadowJar relocate(java.lang.String pattern,
                          java.lang.String destination,
                          org.gradle.api.Action<com.github.jengelman.gradle.plugins.shadow.relocation.SimpleRelocator> configure)

Add a class relocator that maps each class in the pattern to the provided destination.

参数:

pattern - the source pattern to relocate

destination - the destination package

configure - the configuration of the relocator

返回:

this

relocate

public ShadowJar relocate(com.github.jengelman.gradle.plugins.shadow.relocation.Relocator relocator)

Add a relocator instance.

参数:

relocator - the relocator instance to add

返回:

this

relocate

public ShadowJar relocate(java.lang.Class<? extends com.github.jengelman.gradle.plugins.shadow.relocation.Relocator> relocatorClass)
                   throws java.lang.InstantiationException,
                          java.lang.IllegalAccessException,
                          java.lang.NoSuchMethodException,
                          java.lang.reflect.InvocationTargetException

Add a relocator of the provided class.

参数:

relocatorClass - the relocator class to add. Must have a no-arg constructor.

返回:

this

抛出:

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.NoSuchMethodException

java.lang.reflect.InvocationTargetException

relocate

public <R extends com.github.jengelman.gradle.plugins.shadow.relocation.Relocator> ShadowJar relocate(java.lang.Class<R> relocatorClass,
                                                                                                      org.gradle.api.Action<R> configure)
                                                                                               throws java.lang.InstantiationException,
                                                                                                      java.lang.IllegalAccessException,
                                                                                                      java.lang.NoSuchMethodException,
                                                                                                      java.lang.reflect.InvocationTargetException

Add a relocator of the provided class and configure.

参数:

relocatorClass - the relocator class to add. Must have a no-arg constructor

configure - the configuration for the relocator

返回:

this

抛出:

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.NoSuchMethodException

java.lang.reflect.InvocationTargetException

getTransformers

public java.util.List<com.github.jengelman.gradle.plugins.shadow.transformers.Transformer> getTransformers()

setTransformers

public void setTransformers(java.util.List<com.github.jengelman.gradle.plugins.shadow.transformers.Transformer> transformers)

getRelocators

public java.util.List<com.github.jengelman.gradle.plugins.shadow.relocation.Relocator> getRelocators()

setRelocators

public void setRelocators(java.util.List<com.github.jengelman.gradle.plugins.shadow.relocation.Relocator> relocators)

getConfigurations

@Classpath
 @Optional
public java.util.List<org.gradle.api.file.FileCollection> getConfigurations()

setConfigurations

public void setConfigurations(java.util.List<org.gradle.api.file.FileCollection> configurations)

getDependencyFilter

@Internal
public com.github.jengelman.gradle.plugins.shadow.internal.DependencyFilter getDependencyFilter()

setDependencyFilter

public void setDependencyFilter(com.github.jengelman.gradle.plugins.shadow.internal.DependencyFilter filter)