GitRepoArchiveDownloader (Grolifant Core API)

Summary:
Nested
Constructor
Method

| Detail:
Constructor
Method

org.ysb33r.grolifant5.api.core.git.GitRepoArchiveDownloader

@groovy.transform.CompileStatic
class GitRepoArchiveDownloader
extends Object

Downloads an archive from a Git repository.

Authors:: Schalk W. Cronjé

Since:: 2.0

Nested Class Summary

Nested classes
Modifiers	Name	Description
`class`	`GitRepoArchiveDownloader.1`
`class`	`GitRepoArchiveDownloader.2`

Constructor Summary

Constructors
Constructor and description
`GitRepoArchiveDownloader (CloudGitDescriptor descriptor, ConfigCacheSafeOperations gtc)` Download archive from Git Cloud provider.

Methods Summary

Methods
Type Params	Return Type	Name and description
	`File`	`getArchiveRoot()` Returns the location which is the top or home folder for a distribution.
	`void`	`setDownloadRoot(File downloadRootDir)` Sets a download root directory for the distribution.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, toString, hashCode, getClass, notify, notifyAll, wait, wait, wait`

- Constructor Detail
  - @SuppressWarnings(value: DuplicateStringLiteral) GitRepoArchiveDownloader(CloudGitDescriptor descriptor, ConfigCacheSafeOperations gtc)
    
    Download archive from Git Cloud provider.
    Parameters:
    descriptor - Cloud Git provider metadata
    projectOperations - Project operations.
    Since:
    1.0.0
- Method Detail
  - File getArchiveRoot()
    
    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.
  - void setDownloadRoot(File 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.

Summary:
Nested
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation