BootWar (Spring Boot Gradle Plugin API)

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

実装されたすべてのインターフェース:
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>, BootArchive
```
public class BootWar
extends org.gradle.api.tasks.bundling.War
implements BootArchive
```
Spring Boot 実行可能ファイル war を生成するカスタム War タスク。
導入:
2.0.0
作成者:
Andy Wilkinson, Phillip Webb

ネストされたクラスのサマリー
- インターフェース org.gradle.api.Task から継承されたネストクラス / インターフェース
  org.gradle.api.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

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
BootWar()
新しい BootWar タスクを作成します。

コンストラクター
コンストラクターと説明
`BootWar()` 新しい `BootWar` タスクを作成します。

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`copy()`
`protected org.gradle.api.internal.file.copy.CopyAction`	`createCopyAction()`
`LaunchScriptConfiguration`	`getLaunchScript()` アーカイブに付加されるスクリプトを制御する `LaunchScriptConfiguration` を返します。
`LayeredSpec`	`getLayered()` 階層化された jar の層を説明する仕様を返します。
`org.gradle.api.provider.Property<java.lang.String>`	`getMainClass()` アプリケーションのメインクラスの完全修飾名を返します。
`org.gradle.api.file.FileCollection`	`getProvidedClasspath()` 指定されたクラスパスを返します。その内容は、war の `WEB-INF/lib-provided` ディレクトリに含まれます。
`protected boolean`	`isLibrary(org.gradle.api.file.FileCopyDetails details)` `FileCopyDetails` がライブラリ用かどうかを返します。
`void`	`launchScript()` アーカイブを構成して、起動スクリプトを追加します。
`void`	`launchScript(org.gradle.api.Action<LaunchScriptConfiguration> action)` アーカイブにプリペンドされた起動スクリプトを設定し、指定された `action` を使用して設定をカスタマイズします。
`void`	`layered(org.gradle.api.Action<LayeredSpec> action)` 指定された `action` を使用して war のレイヤーを構成します。
`void`	`providedClasspath(java.lang.Object... classpath)` 指定されたクラスパスにファイルを追加して、war の `WEB-INF/lib-provided` ディレクトリに含めます。
`void`	`requiresUnpack(org.gradle.api.specs.Spec<org.gradle.api.file.FileTreeElement> spec)` 起動時にアーカイブから展開する必要があるファイルを識別する仕様を追加します。
`void`	`requiresUnpack(java.lang.String... patterns)` アーカイブの起動時にアーカイブから解凍する必要があるファイルを識別する Ant スタイルのパターンを追加します。
`protected ZipCompression`	`resolveZipCompression(org.gradle.api.file.FileCopyDetails details)` 指定された `details` で表されるファイルを jar に追加するときに使用する必要がある `ZipCompression` を返します。
`void`	`setProvidedClasspath(org.gradle.api.file.FileCollection classpath)` 提供されたクラスパスを設定して、war の `WEB-INF/lib-provided` ディレクトリに含めます。
`void`	`setProvidedClasspath(java.lang.Object classpath)` 提供されたクラスパスを設定して、war の `WEB-INF/lib-provided` ディレクトリに含めます。

クラス org.gradle.api.tasks.bundling.War から継承されたメソッド
classpath, getClasspath, getWebInf, getWebXml, setClasspath, setClasspath, setWebXml, webInf, webInf

クラス org.gradle.api.tasks.bundling.Jar から継承されたメソッド
manifest

クラス 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, 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, 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, setLoggerMessageRewriter

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

インターフェース org.springframework.boot.gradle.tasks.bundling.BootArchive から継承されたメソッド
classpath, getClasspath, setClasspath, setClasspath

インターフェース org.gradle.api.Task から継承されたメソッド
configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, 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

インターフェース java.lang.Comparable から継承されたメソッド
compareTo

インターフェース org.gradle.api.plugins.ExtensionAware から継承されたメソッド
getExtensions

- コンストラクターの詳細
  - BootWar
```
public BootWar()
```
    新しい BootWar タスクを作成します。
- メソッドの詳細
  - copy
```
public void copy()
```
    オーバーライド:
    クラス org.gradle.api.tasks.AbstractCopyTask の copy
  - createCopyAction
```
protected org.gradle.api.internal.file.copy.CopyAction createCopyAction()
```
    オーバーライド:
    クラス org.gradle.api.tasks.bundling.Zip の createCopyAction
  - getMainClass
```
public org.gradle.api.provider.Property<java.lang.String> getMainClass()
```
    インターフェースからコピーされた説明: BootArchive
    アプリケーションのメインクラスの完全修飾名を返します。
    次で指定:
    インターフェース BootArchive の getMainClass
    戻り値:
    アプリケーションのメインクラスの完全修飾名
  - requiresUnpack
```
public void requiresUnpack(java.lang.String... patterns)
```
    インターフェースからコピーされた説明: BootArchive
    アーカイブの起動時にアーカイブから解凍する必要があるファイルを識別する Ant スタイルのパターンを追加します。
    次で指定:
    インターフェース BootArchive の requiresUnpack
    パラメーター:
    patterns - パターン
  - requiresUnpack
```
public void requiresUnpack(org.gradle.api.specs.Spec<org.gradle.api.file.FileTreeElement> spec)
```
    インターフェースからコピーされた説明: BootArchive
    起動時にアーカイブから展開する必要があるファイルを識別する仕様を追加します。
    次で指定:
    インターフェース BootArchive の requiresUnpack
    パラメーター:
    spec - スペック
  - getLaunchScript
```
public LaunchScriptConfiguration getLaunchScript()
```
    インターフェースからコピーされた説明: BootArchive
    アーカイブに付加されるスクリプトを制御する LaunchScriptConfiguration を返します。
    次で指定:
    インターフェース BootArchive の getLaunchScript
    戻り値:
    起動スクリプトの構成、または起動スクリプトが構成されていない場合は null
  - launchScript
```
public void launchScript()
```
    インターフェースからコピーされた説明: BootArchive
    アーカイブを構成して、起動スクリプトを追加します。
    次で指定:
    インターフェース BootArchive の launchScript
  - launchScript
```
public void launchScript(org.gradle.api.Action<LaunchScriptConfiguration> action)
```
    インターフェースからコピーされた説明: BootArchive
    アーカイブにプリペンドされた起動スクリプトを設定し、指定された action を使用して設定をカスタマイズします。
    次で指定:
    インターフェース BootArchive の launchScript
    パラメーター:
    action - 適用するアクション
  - getProvidedClasspath
```
@Optional
 @Classpath
public org.gradle.api.file.FileCollection getProvidedClasspath()
```
    指定されたクラスパスを返します。その内容は、war の WEB-INF/lib-provided ディレクトリに含まれます。
    戻り値:
    提供されたクラスパス
  - providedClasspath
```
public void providedClasspath(java.lang.Object... classpath)
```
    提供されたクラスパスにファイルを追加して、war の WEB-INF/lib-provided ディレクトリに含めます。指定された classpath は Project.files(Object...) に従って評価されます。
    パラメーター:
    classpath - クラスパスへの追加
  - setProvidedClasspath
```
public void setProvidedClasspath(org.gradle.api.file.FileCollection classpath)
```
    提供されたクラスパスを設定して、war の WEB-INF/lib-provided ディレクトリに含めます。
    パラメーター:
    classpath - クラスパス
    導入:
    2.0.7
  - setProvidedClasspath
```
public void setProvidedClasspath(java.lang.Object classpath)
```
    提供されたクラスパスを war の WEB-INF/lib-provided ディレクトリに含めるように設定します。指定された classpath は Project.files(Object...) に従って評価されます。
    パラメーター:
    classpath - クラスパス
    導入:
    2.0.7
  - resolveZipCompression
```
protected ZipCompression resolveZipCompression(org.gradle.api.file.FileCopyDetails details)
```
    指定された details で表されるファイルを jar に追加するときに使用する必要がある ZipCompression を返します。デフォルトでは、すべての library は stored で、他のすべてのファイルは deflated です。
    パラメーター:
    details - ファイルコピーの詳細
    戻り値:
    使用する圧縮
  - getLayered
```
public LayeredSpec getLayered()
```
    階層化された jar の層を説明する仕様を返します。
    戻り値:
    レイヤーの仕様
    導入:
    2.5.0
  - layered
```
public void layered(org.gradle.api.Action<LayeredSpec> action)
```
    指定された action を使用して war のレイヤーを構成します。
    パラメーター:
    action - 適用するアクション
    導入:
    2.5.0
  - isLibrary
```
protected boolean isLibrary(org.gradle.api.file.FileCopyDetails details)
```
    FileCopyDetails がライブラリ用かどうかを返します。デフォルトでは、WEB-INF/lib または WEB-INF/lib-provided のファイルはすべてライブラリと見なされます。
    パラメーター:
    details - ファイルコピーの詳細
    戻り値:
    true （ライブラリの詳細の場合）

クラス BootWar

ネストされたクラスのサマリー

インターフェース org.gradle.api.Task から継承されたネストクラス / インターフェース

フィールドサマリー

クラス org.gradle.api.tasks.bundling.War から継承されたフィールド

クラス org.gradle.jvm.tasks.Jar から継承されたフィールド

クラス org.gradle.api.tasks.bundling.Zip から継承されたフィールド

インターフェース org.gradle.api.Task から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス org.gradle.api.tasks.bundling.War から継承されたメソッド

クラス org.gradle.api.tasks.bundling.Jar から継承されたメソッド

クラス org.gradle.jvm.tasks.Jar から継承されたメソッド

クラス org.gradle.api.tasks.bundling.Zip から継承されたメソッド

クラス org.gradle.api.tasks.bundling.AbstractArchiveTask から継承されたメソッド

クラス org.gradle.api.tasks.AbstractCopyTask から継承されたメソッド

クラス org.gradle.api.internal.ConventionTask から継承されたメソッド

クラス org.gradle.api.DefaultTask から継承されたメソッド

クラス org.gradle.api.internal.AbstractTask から継承されたメソッド

クラス java.lang.Object から継承されたメソッド

インターフェース org.springframework.boot.gradle.tasks.bundling.BootArchive から継承されたメソッド

インターフェース org.gradle.api.Task から継承されたメソッド

インターフェース java.lang.Comparable から継承されたメソッド

インターフェース org.gradle.api.plugins.ExtensionAware から継承されたメソッド

コンストラクターの詳細

BootWar

メソッドの詳細

copy

createCopyAction

getMainClass

requiresUnpack

requiresUnpack

getLaunchScript

launchScript

launchScript

getProvidedClasspath

providedClasspath

setProvidedClasspath

setProvidedClasspath

resolveZipCompression

getLayered

layered

isLibrary