AbstractDistributionInstaller (Grolifant Core API)

org.ysb33r.grolifant5.api.core.downloader.AbstractDistributionInstaller

All Implemented Interfaces and Traits:: DistributionInstaller

@groovy.transform.CompileStatic
@groovy.util.logging.Slf4j
@SuppressWarnings(value: AbstractClassWithoutAbstractMethod)
abstract class AbstractDistributionInstaller
extends AbstractBaseDistributionInstaller
implements DistributionInstaller

Common functionality to be able to download a SDK and use it within Gradle

Authors:: Schalk W. Cronjé

Since:: 2.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`AbstractDistributionInstaller.1`

Inherited fields
Fields inherited from class	Fields
`class AbstractBaseDistributionInstaller`	`IS_MACOSX, IS_WINDOWS, ccso, distributionName, execPatterns`

Properties Summary

Properties
Type	Name and description
`String`	`sdkManCandidateName`

Constructor Summary

Constructors
Constructor and description
`protected AbstractDistributionInstaller (String distributionName, String basePath, ConfigCacheSafeOperations taskComponents)` Creates setup for installing to a local cache.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected File`	`getDistFromCache(String version)` Creates a distribution if it does not exist already.
	`protected File`	`getDistFromSdkMan(String version)` Attempts to locate distribution in the list of SdkMan candidates.
	`Provider<File>`	`getDistributionFile(String version, String fileRelPath)` Locates a file within the distribution
	`Provider<File>`	`getDistributionRoot(String version)` Returns the location which is the top or home folder for a distribution.
	`String`	`getSdkManCandidateName()` SDKman candidate name for distribution.
	`protected File`	`resolveDistributionLocationForVersion(String version)` Resolves distribution location by looking in various locations.
	`void`	`setSdkManCandidateName(String sdkCandidateName)` Set candidate name for SdkMan if the latter should be searched for installed versions

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class AbstractBaseDistributionInstaller`	`addExecPattern, extractFinalExtension, getDistFromCache, listDirs, setChecksum, setDownloadRoot, unpack, unpackParametersForExtension, verifyDistributionRoot, verifyDownloadChecksum`

- Property Detail
  - String sdkManCandidateName
- Constructor Detail
  - protected AbstractDistributionInstaller(String distributionName, String basePath, ConfigCacheSafeOperations taskComponents)
    
    Creates setup for installing to a local cache.
    Parameters:
    distributionName - Descriptive name of the distribution
    basePath - Relative path below Gradle User Home to create cache for all version of this distribution type.
    taskComponents - Gradle project operations that this downloader can use.
- Method Detail
  - protected File getDistFromCache(String version)
    
    Creates a distribution if it does not exist already.
    Returns:
    Location of distribution
  - protected File getDistFromSdkMan(String version)
    
    Attempts to locate distribution in the list of SdkMan candidates.
    Returns:
    Location of the distribution if found in the candidate area.
  - @Override 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.
  - @Override Provider<File> getDistributionRoot(String version)
    
    Returns the location which is the top or home folder for a distribution. This value is affected by setDownloadRoot(java.io.File) and the parameters passed in during construction time.
    Returns:
    Location of the distribution.
  - @Override String getSdkManCandidateName()
    
    SDKman candidate name for distribution.
    Returns:
    Name of SDKman candidate. Can be null.
  - protected File resolveDistributionLocationForVersion(String version)
    
    Resolves distribution location by looking in various locations.
    Parameters:
    version - Version to resolve
    Returns:
    Location or null if nothing could be found.
  - 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.

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractDistributionInstaller

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

String sdkManCandidateName

Constructor Detail

protected AbstractDistributionInstaller(String distributionName, String basePath, ConfigCacheSafeOperations taskComponents)

Method Detail

protected File getDistFromCache(String version)

protected File getDistFromSdkMan(String version)

@Override Provider<File> getDistributionFile(String version, String fileRelPath)

@Override Provider<File> getDistributionRoot(String version)

@Override String getSdkManCandidateName()

protected File resolveDistributionLocationForVersion(String version)

void setSdkManCandidateName(String sdkCandidateName)