Method Detail

• public void addExecPattern(String relPaths)

  Add patterns for files to be marked executable.

  Calling this method multiple times simply appends for patterns

  Parameters:

  relPaths - One or more ANT-stype include patterns

• public Provider<File> getDistributionFile(String version, String fileRelPath)

  Locates a file within the distribution

  Parameters:

  version - Version of distribution to search.

  fileRelPath - Relative path to the distribution root.

  Returns:

  Location of the file in the distribution.

• public Provider<File> getDistributionRoot(String version)

  Returns the location which is the top or home folder for a distribution.

  If the distribution is not local, this will invoke a download. Implementations of this function should take care to cache the download as to not unnecessarily use bandwidth and slow builds down.

  Parameters:

  version - The version that will require locating or downloading.

  Returns:

  Location of the distribution.

• public String getSdkManCandidateName()

  SDKman candidate name for distribution.

  Returns:

  Name of SDKman candidate. Can be null.

• public File locateDistributionInCustomLocation(String version)

  Provide alternative means to look for distributions.

  Parameters:

  version - Version of distribution to locate

  Returns:

  Location of distribution or null if none were found.

• public void setArtifactRootVerification(ArtifactRootVerification arv)

  Sets the method by which to verify an artifact root where package has been unpacked to.

  Parameters:

  arv - Verifier

• public void setArtifactUnpacker(ArtifactUnpacker unpacker)

  Sets the method by which to unpack a downloaded archive. It could also be a way to copy a single downloaded file to a location.

  Parameters:

  unpacker - Unpack mechanism.

• public void setChecksum(String cs)

  Set a checksum that needs to be verified against downloaded archive

  Parameters:

  cs - SHA-256 Hex-encoded checksum

• public void setDownloadRoot(Object downloadRootDir)

  Sets a download root directory for the distribution.

  If not supplied the default is to use the Gradle User Home. This method is provided for convenience and is mostly only used for testing purposes.

  The folder will be created at download time if it does not exist.

  Parameters:

  downloadRootDir - Any writeable directory on the filesystem.

• public void setSdkManCandidateName(String sdkCandidateName)

  Set candidate name for SdkMan if the latter should be searched for installed versions

  Parameters:

  sdkCandidateName - SDK Candidate name. This is the same names that will be shown when running sdk list candidates on the script-line.

• public URI uriFromVersion(String version)

  Creates a download URI from a given distribution version

  Parameters:

  version - Version of the distribution to download

  Returns:

  URI to the where the package is located one