AbstractCloudGit (Grolifant Core API)

org.ysb33r.grolifant5.api.core.git.AbstractCloudGit

All Implemented Interfaces and Traits:

CloudGitConfigurator
```
@groovy.transform.CompileStatic
abstract class AbstractCloudGit
extends Object
implements CloudGitConfigurator
```
Base class for implementing common functionality for Gitlab & GitHub.
Authors:
Schalk W. Cronjé
Since:
2.0

Properties Summary

Properties
Type	Name and description
`Provider<URI>`	`archiveUriProvider`
`String`	`name`

Constructor Summary

Constructors
Constructor and description
`protected AbstractCloudGit (ConfigCacheSafeOperations po, String name, String baseUri)` Constructs a representation of a cloud Git provider

Methods Summary

Methods
Type Params	Return Type	Name and description
	`protected abstract String`	`getArchivePath()` Calculates an archive path for the specific repository type.
	`protected String`	`getIdentifier()` Returns an identifier of an instance in the repository.
	`protected Provider<String>`	`getIdentifierProvider()` Returns an identifier of an instance in the repository.
	`Provider<String>`	`getOrganisationProvider()` Organisation on Git cloud service
	`Provider<String>`	`getRepositoryProvider()` Repository on Git cloud service
	`void`	`setBaseUri(URI uri)`
	`void`	`setBranch(Object branch)` Set the branch.
	`void`	`setCommit(Object commit)` Set the commit to use.
	`void`	`setOrganisation(Object org)` Set the organisation.
	`void`	`setRepository(Object repo)` Set the repository
	`void`	`setTag(Object tag)` Set the tag.
	`String`	`toString()` Content as a string

Inherited Methods Summary

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

- Property Detail
  - final Provider<URI> archiveUriProvider
  - final String name
- Constructor Detail
  - protected AbstractCloudGit(ConfigCacheSafeOperations po, String name, String baseUri)
    
    Constructs a representation of a cloud Git provider
    Parameters:
    name - Name of provider
    baseUri - Base URI to access provider
- Method Detail
  - protected abstract String getArchivePath()
    
    Calculates an archive path for the specific repository type.
    Returns:
    Returns a path that can be used to locate the archive. This path relative to the base URI.
  - @Deprecated protected String getIdentifier()
    
    Returns an identifier of an instance in the repository. @deprecated
    Returns:
    A branch, tag or commit.
  - protected Provider<String> getIdentifierProvider()
    
    Returns an identifier of an instance in the repository.
    Returns:
    A branch, tag or commit.
  - @Override Provider<String> getOrganisationProvider()
    
    Organisation on Git cloud service
    Returns:
    Organisation
    Since:
    5.4
  - @Override Provider<String> getRepositoryProvider()
    
    Repository on Git cloud service
    Returns:
    Repository
    Since:
    5.4
  - @Override void setBaseUri(URI uri)
  - @Override void setBranch(Object branch)
    
    Set the branch. Overrides setTag and setCommit.
    Parameters:
    branch - Anything convertible using StringTools#stringize#stringize
  - @Override void setCommit(Object commit)
    
    Set the commit to use. Overrides setTag and setBranch.
    Parameters:
    commit - Anything convertible using StringTools#stringize#stringize
  - @Override void setOrganisation(Object org)
    
    Set the organisation.
    Parameters:
    org - Anything convertible using StringTools#stringize#stringize
  - @Override void setRepository(Object repo)
    
    Set the repository
    Parameters:
    repo - Anything convertible using StringTools#stringize#stringize
  - @Override void setTag(Object tag)
    
    Set the tag. Overrides setBranch and setCommit.
    Parameters:
    tag - Anything convertible using StringTools#stringize#stringize
  - @Override String toString()
    
    Content as a string
    Returns:
    Equivalent of getArchiveUri.

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class AbstractCloudGit

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

final Provider<URI> archiveUriProvider

final String name

Constructor Detail

protected AbstractCloudGit(ConfigCacheSafeOperations po, String name, String baseUri)

Method Detail

protected abstract String getArchivePath()

@Deprecated protected String getIdentifier()

protected Provider<String> getIdentifierProvider()

@Override Provider<String> getOrganisationProvider()

@Override Provider<String> getRepositoryProvider()

@Override void setBaseUri(URI uri)

@Override void setBranch(Object branch)

@Override void setCommit(Object commit)

@Override void setOrganisation(Object org)

@Override void setRepository(Object repo)

@Override void setTag(Object tag)

@Override String toString()