Class Wrapper

  • All Implemented Interfaces:
    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.

    • Constructor Detail

      • Wrapper

        public Wrapper()
    • Method Detail

      • 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​(File scriptFile)
        The file to write the wrapper script to.
        Since:
        4.0
      • setScriptFile

        public void setScriptFile​(Object scriptFile)
        The file to write the wrapper script to.
      • 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​(File jarFile)
        The file to write the wrapper jar file to.
        Since:
        4.0
      • setJarFile

        public void setJarFile​(Object jarFile)
        The file to write the wrapper jar file to.
      • getPropertiesFile

        @OutputFile
        public File getPropertiesFile()
        Returns the file to write the wrapper properties to.
      • getDistributionPath

        @Input
        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
        See Also:
        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
        See Also:
        setDistributionPath(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.
      • getAvailableDistributionTypes

        public List<Wrapper.DistributionType> getAvailableDistributionTypes()
        The list of available gradle distribution types.
      • 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)
        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.

      • getDistributionBase

        @Input
        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

        @Input
        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

        @Input
        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.