BootWar (Spring Boot Gradle Plugin 2.1.4.RELEASE API)

java.lang.ObjectSE
- 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

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

ネストされたクラスの要約
- インターフェース 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_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` を返します。
`StringSE`	`getMainClassName()` アプリケーションのメインクラスの名前を返します。
`FileCollection`	`getProvidedClasspath()` 指定されたクラスパスを返します。その内容は、war の `WEB-INF/lib-provided` ディレクトリに含まれます。
`boolean`	`isExcludeDevtools()` Devtools jar を除外する必要がある場合は `true` を、そうでない場合は `false` を返します。
`void`	`launchScript()` アーカイブを構成して、起動スクリプトを追加します。
`void`	`launchScript(Action<LaunchScriptConfiguration> action)` アーカイブにプリペンドされた起動スクリプトを設定し、指定された `action` を使用して設定をカスタマイズします。
`void`	`providedClasspath(ObjectSE... classpath)` 指定されたクラスパスにファイルを追加して、war の `WEB-INF/lib-provided` ディレクトリに含めます。
`void`	`requiresUnpack(Spec<FileTreeElement> spec)` 起動時にアーカイブから展開する必要があるファイルを識別する仕様を追加します。
`void`	`requiresUnpack(StringSE... patterns)` アーカイブの起動時にアーカイブから解凍する必要があるファイルを識別する Ant スタイルのパターンを追加します。
`protected ZipCompression`	`resolveZipCompression(FileCopyDetails details)` 指定された `details` で表されるファイルを jar に追加するときに使用される `ZipCompression` を返します。
`void`	`setExcludeDevtools(boolean excludeDevtools)` Devtools jar を除外するかどうかを設定します。
`void`	`setMainClassName(StringSE mainClass)` アプリケーションのメインクラスの名前を設定します。
`void`	`setProvidedClasspath(FileCollection classpath)` 提供されたクラスパスを設定して、war の `WEB-INF/lib-provided` ディレクトリに含めます。
`void`	`setProvidedClasspath(ObjectSE 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, getArchiveName, getArchivePath, getBaseName, getClassifier, getDestinationDir, 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 から継承されたメソッド
newInputDirectory, newInputFile, newOutputDirectory, newOutputFile

クラス org.gradle.api.internal.AbstractTask から継承されたメソッド
addValidator, appendParallelSafeAction, compareTo, configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, doFirst, doFirst, doFirst, doLast, doLast, doLast, execute, finalizedBy, getActions, getAnt, getAsDynamicObject, getConvention, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExecuter, getExtensions, getFinalizedBy, getGroup, getIdentityPath, getImpliesSubProjects, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOnlyIf, getOutputs, getPath, getProject, getServices, getShouldRunAfter, getStandardOutputCapture, getState, getTaskActions, getTaskDependencies, getTemporaryDir, getTemporaryDirFactory, getValidators, hasProperty, injectIntoNewInstance, isEnabled, isHasCustomActions, leftShift, mustRunAfter, onlyIf, onlyIf, prependParallelSafeAction, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setExecuter, setFinalizedBy, setGroup, setImpliesSubProjects, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, toString

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, waitSE, waitSE, waitSE

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

インターフェース org.gradle.api.Task から継承されたメソッド
configure, deleteAllActions, dependsOn, dependsOnTaskDidWork, 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, hasProperty, leftShift, mustRunAfter, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter

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

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

- コンストラクターの詳細
  - BootWar
```
public BootWar()
```
    新しい BootWar タスクを作成します。
- メソッドの詳細
  - copy
```
public void copy()
```
    オーバーライド:
    クラス AbstractCopyTask の copy
  - createCopyAction
```
protected org.gradle.api.internal.file.copy.CopyAction createCopyAction()
```
    オーバーライド:
    クラス Zip の createCopyAction
  - getMainClassName
```
public StringSE getMainClassName()
```
    インターフェースからコピーされた説明: BootArchive
    アプリケーションのメインクラスの名前を返します。
    次で指定:
    インターフェース BootArchive の getMainClassName
    戻り値:
    メインクラス名
  - setMainClassName
```
public void setMainClassName(StringSE mainClass)
```
    インターフェースからコピーされた説明: BootArchive
    アプリケーションのメインクラスの名前を設定します。
    次で指定:
    インターフェース BootArchive の setMainClassName
    パラメーター:
    mainClass - アプリケーションのメインクラスの名前
  - requiresUnpack
```
public void requiresUnpack(StringSE... patterns)
```
    インターフェースからコピーされた説明: BootArchive
    アーカイブの起動時にアーカイブから解凍する必要があるファイルを識別する Ant スタイルのパターンを追加します。
    次で指定:
    インターフェース BootArchive の requiresUnpack
    パラメーター:
    patterns - パターン
  - requiresUnpack
```
public void requiresUnpack(Spec<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(Action<LaunchScriptConfiguration> action)
```
    インターフェースからコピーされた説明: BootArchive
    アーカイブにプリペンドされた起動スクリプトを設定し、指定された action を使用して設定をカスタマイズします。
    次で指定:
    インターフェース BootArchive の launchScript
    パラメーター:
    action - 適用するアクション
  - getProvidedClasspath
```
@Optional
 @Classpath
public FileCollection getProvidedClasspath()
```
    指定されたクラスパスを返します。その内容は、war の WEB-INF/lib-provided ディレクトリに含まれます。
    戻り値:
    提供されたクラスパス
  - providedClasspath
```
public void providedClasspath(ObjectSE... classpath)
```
    指定されたクラスパスにファイルを追加して、war の WEB-INF/lib-provided ディレクトリに含めます。指定された classpath は Project.files(Object...) に従って評価されます。
    パラメーター:
    classpath - クラスパスへの追加
  - setProvidedClasspath
```
public void setProvidedClasspath(FileCollection classpath)
```
    提供されたクラスパスを設定して、war の WEB-INF/lib-provided ディレクトリに含めます。
    パラメーター:
    classpath - クラスパス
    導入:
    2.0.7
  - setProvidedClasspath
```
public void setProvidedClasspath(ObjectSE classpath)
```
    提供されたクラスパスを設定して、war の WEB-INF/lib-provided ディレクトリに含めます。指定された classpath は Project.files(Object...) に従って評価されます。
    パラメーター:
    classpath - クラスパス
    導入:
    2.0.7
  - isExcludeDevtools
```
public boolean isExcludeDevtools()
```
    インターフェースからコピーされた説明: BootArchive
    Devtools jar を除外する必要がある場合は true を、そうでない場合は false を返します。
    次で指定:
    インターフェース BootArchive の isExcludeDevtools
    戻り値:
    Devtools jar を除外する場合は true、除外しない場合は false
  - setExcludeDevtools
```
public void setExcludeDevtools(boolean excludeDevtools)
```
    インターフェースからコピーされた説明: BootArchive
    Devtools jar を除外するかどうかを設定します。
    次で指定:
    インターフェース BootArchive の setExcludeDevtools
    パラメーター:
    excludeDevtools - Devtools jar を除外する必要がある場合は true、除外しない場合は false
  - resolveZipCompression
```
protected ZipCompression resolveZipCompression(FileCopyDetails details)
```
    指定された details で表されるファイルを jar に追加するときに使用される ZipCompression を返します。
    デフォルトでは、WEB-INF/lib/ または WEB-INF/lib-provided/ のファイルはすべて保存され、他のすべてのファイルは収縮されます。
    パラメーター:
    details - 詳細
    戻り値:
    使用する圧縮

クラス 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.ObjectSE から継承されたメソッド

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

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

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

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

コンストラクターの詳細

BootWar

メソッドの詳細

copy

createCopyAction

getMainClassName

setMainClassName

requiresUnpack

requiresUnpack

getLaunchScript

launchScript

launchScript

getProvidedClasspath

providedClasspath

setProvidedClasspath

setProvidedClasspath

isExcludeDevtools

setExcludeDevtools

resolveZipCompression