Versioner (gradle-versioner 3.0.15 API)

com.sarhanm.versioner.Versioner

Generates a solid and snapshot version using information derived from the git repository

Properties Summary

Properties
Type	Name and description
`static java.lang.Object`	`CMD_BRANCH`
`static java.lang.Object`	`CMD_COMMIT_HASH`
`static java.lang.Object`	`CMD_MAJOR_MINOR`
`static java.lang.Object`	`CMD_POINT`
`static java.lang.Object`	`CMD_POINT_SOLID_BRANCH`
`static java.lang.Object`	`DEFAULT_HOTFIX_COMMON_BRANCH`
`static java.lang.Object`	`DEFAULT_SOLID_BRANCH_REGEX`
`VersionerOptions`	`options`

Constructor Summary

Constructors
Constructor and description
`Versioner ()`
`Versioner (VersionerOptions versionerOptions, org.gradle.api.Project project)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`java.lang.Object`	`cleanseBranchName(java.lang.Object branchName)`
	`java.lang.String`	`getBranch()` @return Branch name without the remote and/or origin prefix
	`java.lang.String`	`getBranchNameRaw()`
	`java.lang.String`	`getCleansedBranchName()` @return Branch name without slashes or dots
	`java.lang.String`	`getCommitHash()`
	`int`	`getHotfixNumber()` @return Hotfix version number as integer
	`java.lang.String`	`getMajorMinor()` @return Major and minor version numbers as String (such as "3.4")
	`int`	`getMajorNumber()` @return Major version number as integer
	`int`	`getMinorNumber()` @return Minor version number as integer
	`int`	`getPointNumber()` @return Point version number as integer
	`java.lang.String`	`getTotalCommits()` @return total commits since the inception of the repo
	`java.lang.String`	`getVersion()` @return The full version major.minor.point.branch-name
	`java.lang.String`	`getVersionPoint()` Returns: Point version number as String.
	`java.lang.Object`	`omitBranchMetadata()`
	`java.lang.Object`	`plus(java.lang.Object other)`
	`java.lang.Object`	`removeBranchPrefixes(java.lang.Object branchName)`
	`java.lang.String`	`toString()`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - static final java.lang.Object CMD_BRANCH
  - static final java.lang.Object CMD_COMMIT_HASH
  - static final java.lang.Object CMD_MAJOR_MINOR
  - static final java.lang.Object CMD_POINT
  - static final java.lang.Object CMD_POINT_SOLID_BRANCH
  - static final java.lang.Object DEFAULT_HOTFIX_COMMON_BRANCH
  - static final java.lang.Object DEFAULT_SOLID_BRANCH_REGEX
  - VersionerOptions options
- Constructor Detail
  - Versioner()
  - Versioner(VersionerOptions versionerOptions, org.gradle.api.Project project)
- Method Detail
  - java.lang.Object cleanseBranchName(java.lang.Object branchName)
  - java.lang.String getBranch()
    
    Returns:
    Branch name without the remote and/or origin prefix
  - @groovy.transform.Memoized java.lang.String getBranchNameRaw()
  - java.lang.String getCleansedBranchName()
    
    Returns:
    Branch name without slashes or dots
  - java.lang.String getCommitHash()
  - int getHotfixNumber()
    
    Returns:
    Hotfix version number as integer
  - java.lang.String getMajorMinor()
    
    Returns:
    Major and minor version numbers as String (such as "3.4")
  - int getMajorNumber()
    
    Returns:
    Major version number as integer
  - int getMinorNumber()
    
    Returns:
    Minor version number as integer
  - int getPointNumber()
    
    Returns:
    Point version number as integer
  - java.lang.String getTotalCommits()
    
    Returns:
    total commits since the inception of the repo
  - java.lang.String getVersion()
    
    Returns:
    The full version major.minor.point.branch-name
  - java.lang.String getVersionPoint()
    
    Returns:
    Point version number as String. May contain both point and hotfix numbers for a hotfix branch (such as "5.2")
  - java.lang.Object omitBranchMetadata()
  - java.lang.Object plus(java.lang.Object other)
  - java.lang.Object removeBranchPrefixes(java.lang.Object branchName)
  - @groovy.transform.Memoized java.lang.String toString()

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class Versioner

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

static final java.lang.Object CMD_BRANCH

static final java.lang.Object CMD_COMMIT_HASH

static final java.lang.Object CMD_MAJOR_MINOR

static final java.lang.Object CMD_POINT

static final java.lang.Object CMD_POINT_SOLID_BRANCH

static final java.lang.Object DEFAULT_HOTFIX_COMMON_BRANCH

static final java.lang.Object DEFAULT_SOLID_BRANCH_REGEX

VersionerOptions options

Constructor Detail

Versioner()

Versioner(VersionerOptions versionerOptions, org.gradle.api.Project project)

Method Detail

java.lang.Object cleanseBranchName(java.lang.Object branchName)

java.lang.String getBranch()

@groovy.transform.Memoized java.lang.String getBranchNameRaw()

java.lang.String getCleansedBranchName()

java.lang.String getCommitHash()

int getHotfixNumber()

java.lang.String getMajorMinor()

int getMajorNumber()

int getMinorNumber()

int getPointNumber()

java.lang.String getTotalCommits()

java.lang.String getVersion()

java.lang.String getVersionPoint()

java.lang.Object omitBranchMetadata()

java.lang.Object plus(java.lang.Object other)

java.lang.Object removeBranchPrefixes(java.lang.Object branchName)

@groovy.transform.Memoized java.lang.String toString()