|
Groovy Documentation | |||||||
FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
org.gradle.api.tasks.wrapper.Wrapper
class Wrapper extends DefaultTask
The wrapper task generates scripts (for *nix and windows) which enable to build your project with Gradle, without having to install Gradle. The scripts generated by this task are supposed to be commited to your version control system. This tasks also copies a gradle-wrapper.jar to your project dir which needs also be commited into your VCS. The scripts delegates to this jar. If a user execute a wrapper script the first time, the script downloads the gradle-distribution and runs the build against the downloaded distribution. Any installed Gradle distribution is ignored when using the wrapper scripts. Alternatively you can store the distribution for the wrapper in your version control system.
Nested Class Summary | |
---|---|
enum |
Wrapper.PathBase
|
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_ARCHIVE_CLASSIFIER
|
static java.lang.String |
DEFAULT_ARCHIVE_NAME
|
static java.lang.String |
DEFAULT_DISTRIBUTION_PARENT_NAME
|
static java.lang.String |
DEFAULT_URL_ROOT
|
static java.lang.String |
WRAPPER_JAR_BASE_NAME
|
Constructor Summary | |
Wrapper(Project project, java.lang.String name)
|
Method Summary | |
---|---|
PathBase
|
getArchiveBase()
Returns the archive base. |
java.lang.String
|
getArchiveClassifier()
Returns the archive classifier. |
java.lang.String
|
getArchiveName()
Returnes the archive name. |
java.lang.String
|
getArchivePath()
Returns the archive path. |
PathBase
|
getDistributionBase()
Returns the distribution base. |
java.lang.String
|
getDistributionPath()
Returns the distribution path. |
java.lang.String
|
getGradleVersion()
Returns the gradle version for the wrapper. |
java.lang.String
|
getJarPath()
Returns the jar path. |
java.lang.String
|
getScriptDestinationPath()
Returns the script destination path. |
WrapperScriptGenerator
|
getUnixWrapperScriptGenerator()
|
java.lang.String
|
getUrlRoot()
|
void
|
setArchiveBase(PathBase archiveBase)
The distribution base specifies whether the unpacked wrapper distribution should be stored in the project or in the gradle user home dir. |
void
|
setArchiveClassifier(java.lang.String archiveClassifier)
Specifies the classifier of the archive as part of the download URL. |
void
|
setArchiveName(java.lang.String archiveName)
Specifies the name of the archive as part of the download URL. |
void
|
setArchivePath(java.lang.String archivePath)
Set's the path where the gradle distributions archive should be saved (i.e. the parent dir). |
void
|
setDistributionBase(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(java.lang.String distributionPath)
Set's the path where the gradle distributions needed by the wrapper are unzipped. |
void
|
setGradleVersion(java.lang.String gradleVersion)
The version of the gradle distribution required by the wrapper. |
void
|
setJarPath(java.lang.String jarPath)
When executing the wrapper task, the jar path specifies the path where the gradle-wrapper.jar is copied to. |
void
|
setScriptDestinationPath(java.lang.String scriptDestinationPath)
Specifies a path as the parent dir of the scripts which are generated when executing the wrapper task. |
void
|
setUnixWrapperScriptGenerator(WrapperScriptGenerator wrapperScriptGenerator)
|
void
|
setUrlRoot(java.lang.String urlRoot)
A URL where to download the gradle distribution from. |
Wrapper
|
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
org.gradle.api.tasks.wrapper.Wrapper[]
|
values()
Returns an array containing the constants of this enum type, in the order they are declared. |
Methods inherited from class DefaultTask | |
---|---|
leftShift, methodMissing, propertyMissing |
Methods inherited from class java.lang.Object | |
---|---|
hashCode, getClass, equals, toString, wait, wait, wait, notify, notifyAll |
Field Detail |
---|
static final java.lang.String DEFAULT_ARCHIVE_CLASSIFIER
static final java.lang.String DEFAULT_ARCHIVE_NAME
static final java.lang.String DEFAULT_DISTRIBUTION_PARENT_NAME
static final java.lang.String DEFAULT_URL_ROOT
static final java.lang.String WRAPPER_JAR_BASE_NAME
Constructor Detail |
---|
public Wrapper(Project project, java.lang.String name)
Method Detail |
---|
public PathBase getArchiveBase()
public java.lang.String getArchiveClassifier()
public java.lang.String getArchiveName()
public java.lang.String getArchivePath()
public PathBase getDistributionBase()
public java.lang.String getDistributionPath()
public java.lang.String getGradleVersion()
public java.lang.String getJarPath()
public java.lang.String getScriptDestinationPath()
public WrapperScriptGenerator getUnixWrapperScriptGenerator()
public java.lang.String getUrlRoot()
public void setArchiveBase(PathBase archiveBase)
public void setArchiveClassifier(java.lang.String archiveClassifier)
#getUrlRoot()/#getArchiveName()-#getArchiveClassifier()-#getGradleVersion().zip
The default for the archive classifier is #DEFAULT_ARCHIVE_CLASSIFIER.
public void setArchiveName(java.lang.String archiveName)
#getUrlRoot()/#getArchiveName()-#getArchiveClassifier()-#getGradleVersion().zip
The default for the archive name is #DEFAULT_ARCHIVE_NAME.
public void setArchivePath(java.lang.String archivePath)
public void setDistributionBase(PathBase distributionBase)
public void setDistributionPath(java.lang.String distributionPath)
public void setGradleVersion(java.lang.String gradleVersion)
public void setJarPath(java.lang.String jarPath)
public void setScriptDestinationPath(java.lang.String scriptDestinationPath)
toString
method specifies the path.
Most likely a String or File object.
public void setUnixWrapperScriptGenerator(WrapperScriptGenerator wrapperScriptGenerator)
public void setUrlRoot(java.lang.String urlRoot)
#getUrlRoot()/#getArchiveName()-#getArchiveClassifier()-#getGradleVersion().zip
.
The default for the URL root is #DEFAULT_URL_ROOT.
The wrapper downloads a certain distribution only ones and caches it.
If your #getDistributionBase() 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.
Wrapper valueOf(java.lang.String name)
org.gradle.api.tasks.wrapper.Wrapper[] values()
Groovy Documentation