AbstractCloudGit (docs 4.0.0 API)

org.ysb33r.grolifant.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
`URI`	`baseUri`
`String`	`organisation`
`String`	`repository`

Constructor Summary

Constructors
Constructor and description
`protected AbstractCloudGit (ProjectOperations 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.
	`URI`	`getArchiveUri()` Obtains the URI for the archive of the repository.
	`protected String`	`getIdentifier()` Returns an identifier of an instance in the repository.
	`String`	`getName()` Obtains the name of the Git service.
	`String`	`getOrganisation()` Get the organisation
	`String`	`getRepository()` Get the repository
	`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`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Property Detail
  - URI baseUri
  - String organisation
  - String repository
- Constructor Detail
  - protected AbstractCloudGit(ProjectOperations 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 getBaseUri.
  - @Override URI getArchiveUri()
    
    Obtains the URI for the archive of the repository.
    Returns:
    Repo URI
  - protected String getIdentifier()
    
    Returns an identifier of an instance in the repository.
    Returns:
    A branch, tag or commit.
  - @Override String getName()
    
    Obtains the name of the Git service.
    Returns:
    Service name.
  - String getOrganisation()
    
    Get the organisation
    Returns:
    Organisation as a string
  - String getRepository()
    
    Get the repository
    Returns:
    Repository as a string
  - @Override void setBranch(Object branch)
    
    Set the branch. Overrides setTag and setCommit.
    Parameters:
    branch - Anything convertible using StringTools.stringize
  - @Override void setCommit(Object commit)
    
    Set the commit to use. Overrides setTag and setBranch.
    Parameters:
    commit - Anything convertible using StringTools.stringize
  - @Override void setOrganisation(Object org)
    
    Set the organisation.
    Parameters:
    org - Anything convertible using StringTools.stringize
  - @Override void setRepository(Object repo)
    
    Set the repository
    Parameters:
    repo - Anything convertible using StringTools.stringize
  - @Override void setTag(Object tag)
    
    Set the tag. Overrides setBranch and setCommit.
    Parameters:
    tag - Anything convertible using StringTools.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

URI baseUri

String organisation

String repository

Constructor Detail

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

Method Detail

protected abstract String getArchivePath()

@Override URI getArchiveUri()

protected String getIdentifier()

@Override String getName()

String getOrganisation()

String getRepository()

@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()