类 BootWar
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
org.gradle.api.tasks.bundling.War
org.springframework.boot.gradle.tasks.bundling.BootWar
- 所有已实现的接口:
Comparable<Task>
,ContentFilterable
,CopyProcessingSpec
,CopySourceSpec
,CopySpec
,org.gradle.api.internal.DynamicObjectAware
,org.gradle.api.internal.file.copy.CopySpecSource
,org.gradle.api.internal.IConventionAware
,org.gradle.api.internal.TaskInternal
,Named
,ExtensionAware
,Task
,PatternFilterable
,Configurable<Task>
,BootArchive
@DisableCachingByDefault(because="Not worth caching")
public abstract class BootWar
extends War
implements BootArchive
A custom
War
task that produces a Spring Boot executable war.- 从以下版本开始:
- 2.0.0
- 作者:
- Andy Wilkinson, Phillip Webb, Scott Frederick
-
嵌套类概要
从接口继承的嵌套类/接口 org.gradle.api.Task
Task.Namer
-
字段概要
从类继承的字段 org.gradle.api.tasks.bundling.War
WAR_EXTENSION
从类继承的字段 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
-
构造器概要
构造器 -
方法概要
修饰符和类型方法说明void
copy()
protected org.gradle.api.internal.file.copy.CopyAction
Returns theLaunchScriptConfiguration
that will control the script that is prepended to the archive.Returns the spec that describes the layers in a layered jar.Returns the provided classpath, the contents of which will be included in theWEB-INF/lib-provided
directory of the war.protected boolean
isLibrary
(FileCopyDetails details) Return if theFileCopyDetails
are for a library.void
Configures the archive to have a prepended launch script.void
launchScript
(Action<LaunchScriptConfiguration> action) Configures the archive to have a prepended launch script, customizing its configuration using the givenaction
.void
layered
(Action<LayeredSpec> action) Configures the war's layering using the givenaction
.void
providedClasspath
(Object... classpath) Adds files to the provided classpath to include in theWEB-INF/lib-provided
directory of the war.void
requiresUnpack
(String... patterns) Adds Ant-style patterns that identify files that must be unpacked from the archive when it is launched.void
requiresUnpack
(Spec<FileTreeElement> spec) Adds a spec that identifies files that must be unpacked from the archive when it is launched.void
resolvedArtifacts
(Provider<Set<ResolvedArtifactResult>> resolvedArtifacts) Registers the given lazily providedresolvedArtifacts
.protected ZipCompression
resolveZipCompression
(FileCopyDetails details) Return theZipCompression
that should be used when adding the file represented by the givendetails
to the jar.void
setProvidedClasspath
(Object classpath) Sets the provided classpath to include in theWEB-INF/lib-provided
directory of the war.void
setProvidedClasspath
(FileCollection classpath) Sets the provided classpath to include in theWEB-INF/lib-provided
directory of the war.从类继承的方法 org.gradle.api.tasks.bundling.War
classpath, getClasspath, getObjectFactory, getWebAppDirectory, getWebInf, getWebXml, setClasspath, setClasspath, setWebXml, webInf, webInf
从类继承的方法 org.gradle.jvm.tasks.Jar
getManifest, 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, getArchiveAppendix, getArchiveBaseName, getArchiveClassifier, getArchiveExtension, getArchiveFile, getArchiveFileName, getArchivePath, getArchiveVersion, getDestinationDirectory, into, into, into, isPreserveFileTimestamps, isReproducibleFileOrder, setPreserveFileTimestamps, setReproducibleFileOrder
从类继承的方法 org.gradle.api.tasks.AbstractCopyTask
createRootSpec, dirPermissions, eachFile, eachFile, exclude, exclude, exclude, exclude, expand, expand, filePermissions, filesMatching, filesMatching, filesNotMatching, filesNotMatching, filter, filter, filter, filter, from, from, from, getDirectoryFileTreeFactory, getDirMode, getDirPermissions, getDocumentationRegistry, getDuplicatesStrategy, getExcludes, getFileLookup, getFileMode, getFilePermissions, getFileResolver, getFileSystem, getFilteringCharset, getIncludeEmptyDirs, getIncludes, getInstantiator, getMainSpec, getPropertyFactory, 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, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService
从类继承的方法 org.gradle.api.internal.AbstractTask
acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects
从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
从接口继承的方法 org.springframework.boot.gradle.tasks.bundling.BootArchive
classpath, getClasspath, getIncludeTools, getLoaderImplementation, getMainClass, getTargetJavaVersion, setClasspath, setClasspath
从接口继承的方法 java.lang.Comparable
compareTo
从接口继承的方法 org.gradle.api.plugins.ExtensionAware
getExtensions
从接口继承的方法 org.gradle.api.Task
configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, doNotTrackState, finalizedBy, getActions, getAnt, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getFinalizedBy, getGroup, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getPath, getProject, getShouldRunAfter, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, notCompatibleWithConfigurationCache, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService
-
构造器详细资料
-
BootWar
public BootWar()Creates a newBootWar
task.
-
-
方法详细资料
-
resolvedArtifacts
从接口复制的说明:BootArchive
Registers the given lazily providedresolvedArtifacts
. They are used to map from the files in theclasspath
to their dependency coordinates.- 指定者:
resolvedArtifacts
在接口中BootArchive
- 参数:
resolvedArtifacts
- the lazily provided resolved artifacts
-
copy
public void copy()- 覆盖:
copy
在类中AbstractCopyTask
-
createCopyAction
protected org.gradle.api.internal.file.copy.CopyAction createCopyAction()- 覆盖:
createCopyAction
在类中Zip
-
requiresUnpack
从接口复制的说明:BootArchive
Adds Ant-style patterns that identify files that must be unpacked from the archive when it is launched.- 指定者:
requiresUnpack
在接口中BootArchive
- 参数:
patterns
- the patterns
-
requiresUnpack
从接口复制的说明:BootArchive
Adds a spec that identifies files that must be unpacked from the archive when it is launched.- 指定者:
requiresUnpack
在接口中BootArchive
- 参数:
spec
- the spec
-
getLaunchScript
从接口复制的说明:BootArchive
Returns theLaunchScriptConfiguration
that will control the script that is prepended to the archive.- 指定者:
getLaunchScript
在接口中BootArchive
- 返回:
- the launch script configuration, or
null
if the launch script has not been configured.
-
launchScript
public void launchScript()从接口复制的说明:BootArchive
Configures the archive to have a prepended launch script.- 指定者:
launchScript
在接口中BootArchive
-
launchScript
从接口复制的说明:BootArchive
Configures the archive to have a prepended launch script, customizing its configuration using the givenaction
.- 指定者:
launchScript
在接口中BootArchive
- 参数:
action
- the action to apply
-
getProvidedClasspath
Returns the provided classpath, the contents of which will be included in theWEB-INF/lib-provided
directory of the war.- 返回:
- the provided classpath
-
providedClasspath
Adds files to the provided classpath to include in theWEB-INF/lib-provided
directory of the war. The givenclasspath
is evaluated as perProject.files(Object...)
.- 参数:
classpath
- the additions to the classpath
-
setProvidedClasspath
Sets the provided classpath to include in theWEB-INF/lib-provided
directory of the war.- 参数:
classpath
- the classpath- 从以下版本开始:
- 2.0.7
-
setProvidedClasspath
Sets the provided classpath to include in theWEB-INF/lib-provided
directory of the war. The givenclasspath
is evaluated as perProject.files(Object...)
.- 参数:
classpath
- the classpath- 从以下版本开始:
- 2.0.7
-
resolveZipCompression
Return theZipCompression
that should be used when adding the file represented by the givendetails
to the jar. By default, anylibrary
isstored
and all other files aredeflated
.- 参数:
details
- the file copy details- 返回:
- the compression to use
-
getLayered
Returns the spec that describes the layers in a layered jar.- 返回:
- the spec for the layers
- 从以下版本开始:
- 2.5.0
-
layered
Configures the war's layering using the givenaction
.- 参数:
action
- the action to apply- 从以下版本开始:
- 2.5.0
-
isLibrary
Return if theFileCopyDetails
are for a library. By default any file inWEB-INF/lib
orWEB-INF/lib-provided
is considered to be a library.- 参数:
details
- the file copy details- 返回:
true
if the details are for a library
-