Wrapper (Gradle API 2.2-20140924021627+0000)

java.lang.Object
- org.gradle.api.internal.AbstractTask
- - org.gradle.api.DefaultTask
  - - org.gradle.api.tasks.wrapper.Wrapper

すべての実装されたインタフェース:

Comparable<Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, ExtensionAware, Task, org.gradle.util.Configurable<Task>
```
public class Wrapper
extends DefaultTask
```
Generates scripts (for *nix and windows) which allow you to build your project with Gradle, without having to install Gradle.
When a user executes a wrapper script the first time, the script downloads and installs the appropriate Gradle distribution and runs the build against this downloaded distribution. Any installed Gradle distribution is ignored when using the wrapper scripts.
The scripts generated by this task are intended to be committed to your version control system. This task also generates a small gradle-wrapper.jar bootstrap JAR file and properties file which should also be committed to your VCS. The scripts delegates to this JAR.

ネストされたクラスの概要

ネストされたクラス
修飾子とタイプクラスと説明

static class Wrapper.PathBase
Specifies how the wrapper path should be interpreted.
- インタフェースから継承されたネストされたクラス/インタフェース org.gradle.api.Task
  Task.Namer

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`Wrapper.PathBase` Specifies how the wrapper path should be interpreted.

フィールドの概要

フィールド
修飾子とタイプフィールドと説明

static String DEFAULT_DISTRIBUTION_PARENT_NAME
- インタフェースから継承されたフィールド org.gradle.api.Task
  TASK_ACTION, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE

フィールド
修飾子とタイプ	フィールドと説明
`static String`	`DEFAULT_DISTRIBUTION_PARENT_NAME`

コンストラクタの概要

コンストラクタ
コンストラクタと説明

Wrapper()

コンストラクタ
コンストラクタと説明
`Wrapper()`

メソッドの概要

All Methods Instance Methods Concrete Methods
修飾子とタイプ	メソッドと説明
`Wrapper.PathBase`	`getArchiveBase()` The archive base specifies whether the unpacked wrapper distribution should be stored in the project or in the gradle user home dir.
`String`	`getArchivePath()` Returns the path where the gradle distributions archive should be saved (i.e. the parent dir).
`File`	`getBatchScript()` Returns the file to write the wrapper batch script to.
`Wrapper.PathBase`	`getDistributionBase()` The distribution base specifies whether the unpacked wrapper distribution should be stored in the project or in the gradle user home dir.
`String`	`getDistributionPath()` Returns the path where the gradle distributions needed by the wrapper are unzipped.
`String`	`getDistributionUrl()` The URL to download the gradle distribution from.
`protected org.gradle.api.internal.file.FileLookup`	`getFileLookup()`
`String`	`getGradleVersion()` Returns the gradle version for the wrapper.
`File`	`getJarFile()` Returns the file to write the wrapper jar file to.
`File`	`getPropertiesFile()` Returns the file to write the wrapper properties to.
`File`	`getScriptFile()` Returns the file to write the wrapper script to.
`void`	`setArchiveBase(Wrapper.PathBase archiveBase)` The archive base specifies whether the unpacked wrapper distribution should be stored in the project or in the gradle user home dir.
`void`	`setArchivePath(String archivePath)` Set's the path where the gradle distributions archive should be saved (i.e. the parent dir).
`void`	`setDistributionBase(Wrapper.PathBase distributionBase)` The distribution base specifies whether the unpacked wrapper distribution should be stored in the project or in the gradle user home dir.
`void`	`setDistributionPath(String distributionPath)` Sets the path where the gradle distributions needed by the wrapper are unzipped.
`void`	`setDistributionUrl(String url)`
`void`	`setGradleVersion(String gradleVersion)` The version of the gradle distribution required by the wrapper.
`void`	`setJarFile(Object jarFile)`
`void`	`setScriptFile(Object scriptFile)`

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

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

- フィールドの詳細
  - DEFAULT_DISTRIBUTION_PARENT_NAME
```
public static final String DEFAULT_DISTRIBUTION_PARENT_NAME
```
    関連項目:
    
    定数フィールド値
- コンストラクタの詳細
  - Wrapper
```
public Wrapper()
```
- メソッドの詳細
  - getFileLookup
```
@Inject
protected org.gradle.api.internal.file.FileLookup getFileLookup()
```
  - getScriptFile
```
@OutputFile
public File getScriptFile()
```
    Returns the file to write the wrapper script to.
  - setScriptFile
```
public void setScriptFile(Object scriptFile)
```
  - getBatchScript
```
@OutputFile
public File getBatchScript()
```
    Returns the file to write the wrapper batch script to.
  - getJarFile
```
@OutputFile
public File getJarFile()
```
    Returns the file to write the wrapper jar file to.
  - setJarFile
```
public void setJarFile(Object jarFile)
```
  - getPropertiesFile
```
@OutputFile
public File getPropertiesFile()
```
    Returns the file to write the wrapper properties to.
  - getDistributionPath
```
public String getDistributionPath()
```
    Returns the path where the gradle distributions needed by the wrapper are unzipped. The path is relative to the distribution base directory
    
    関連項目:
    
    setDistributionPath(String)
  - setDistributionPath
```
public void setDistributionPath(String distributionPath)
```
    Sets the path where the gradle distributions needed by the wrapper are unzipped. The path is relative to the distribution base directory
    
    関連項目:
    
    setDistributionPath(String)
  - getGradleVersion
```
public String getGradleVersion()
```
    Returns the gradle version for the wrapper.
    
    関連項目:
    
    setGradleVersion(String)
  - setGradleVersion
```
public void setGradleVersion(String gradleVersion)
```
    The version of the gradle distribution required by the wrapper. This is usually the same version of Gradle you use for building your project.
  - getDistributionUrl
```
@Input
public String getDistributionUrl()
```
    The URL to download the gradle distribution from.
    If not set, the download URL is the default for the specified getGradleVersion().
    If getGradleVersion() is not set, will return null.
    The wrapper downloads a certain distribution only once and caches it. If your distribution base is the project, you might submit the distribution to your version control system. That way no download is necessary at all. This might be in particular interesting, if you provide a custom gradle snapshot to the wrapper, because you don't need to provide a download server then.
  - setDistributionUrl
```
public void setDistributionUrl(String url)
```
  - getDistributionBase
```
public Wrapper.PathBase getDistributionBase()
```
    The distribution base specifies whether the unpacked wrapper distribution should be stored in the project or in the gradle user home dir.
  - setDistributionBase
```
public void setDistributionBase(Wrapper.PathBase distributionBase)
```
    The distribution base specifies whether the unpacked wrapper distribution should be stored in the project or in the gradle user home dir.
  - getArchivePath
```
public String getArchivePath()
```
    Returns the path where the gradle distributions archive should be saved (i.e. the parent dir). The path is relative to the archive base directory.
  - setArchivePath
```
public void setArchivePath(String archivePath)
```
    Set's the path where the gradle distributions archive should be saved (i.e. the parent dir). The path is relative to the parent dir specified with getArchiveBase().
  - getArchiveBase
```
public Wrapper.PathBase getArchiveBase()
```
    The archive base specifies whether the unpacked wrapper distribution should be stored in the project or in the gradle user home dir.
  - setArchiveBase
```
public void setArchiveBase(Wrapper.PathBase archiveBase)
```
    The archive base specifies whether the unpacked wrapper distribution should be stored in the project or in the gradle user home dir.

クラス Wrapper

ネストされたクラスの概要

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

フィールドの概要

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

コンストラクタの概要

メソッドの概要

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

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

フィールドの詳細

DEFAULT_DISTRIBUTION_PARENT_NAME

コンストラクタの詳細

Wrapper

メソッドの詳細

getFileLookup

getScriptFile

setScriptFile

getBatchScript

getJarFile

setJarFile

getPropertiesFile

getDistributionPath

setDistributionPath

getGradleVersion

setGradleVersion

getDistributionUrl

setDistributionUrl

getDistributionBase

setDistributionBase

getArchivePath

setArchivePath

getArchiveBase

setArchiveBase