```
public final class GitVersionService

                    
```
Calculate the version from a Git Repository. The repository uses GitFlow for the development. The start parameter is the local source directory.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`GitVersionService.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final Git`	`client`
`private final Repository`	`repository`
`private final String`	`branch`
`private String`	`mainBranch`
`private String`	`developBranch`
`private String`	`hotfixPrefix`
`private String`	`featurePrefix`
`private String`	`releasePrefix`
`private String`	`versionPrefix`
`private String`	`separator`
`private Boolean`	`localOnly`
`private Boolean`	`shortened`
`private Version`	`defaultVersion`
`private final String`	`version`
`private final String`	`containerVersion`
`private final String`	`revID`
`private final String`	`previousVersion`

Constructor Summary

Constructors
Constructor	Description
`GitVersionService(File directory, VersionType versionType)`	creates the service from a directory
`GitVersionService(File directory)`	creates the service from a directory

Method Summary

Modifier and Type	Method	Description
`final Git`	`getClient()`	Git client for the existing working copy.
`final Repository`	`getRepository()`	Repository for the existing working copy.
`final String`	`getBranch()`	This is the current branch name.
`final String`	`getMainBranch()`	Name of the main branch.
`final Unit`	`setMainBranch(String mainBranch)`	Name of the main branch.
`final String`	`getDevelopBranch()`	Name of the develop branch.
`final Unit`	`setDevelopBranch(String developBranch)`	Name of the develop branch.
`final String`	`getHotfixPrefix()`	Prefix of a hotfix branch.
`final Unit`	`setHotfixPrefix(String hotfixPrefix)`	Prefix of a hotfix branch.
`final String`	`getFeaturePrefix()`	Prefix of a feature branch.
`final Unit`	`setFeaturePrefix(String featurePrefix)`	Prefix of a feature branch.
`final String`	`getReleasePrefix()`	Prefix of a release branch.
`final Unit`	`setReleasePrefix(String releasePrefix)`	Prefix of a release branch.
`final String`	`getVersionPrefix()`	Prefix of a version tag.
`final Unit`	`setVersionPrefix(String versionPrefix)`	Prefix of a version tag.
`final String`	`getSeparator()`	Separator for prefix and branch name.
`final Unit`	`setSeparator(String separator)`	Separator for prefix and branch name.
`final Boolean`	`getLocalOnly()`	Version can be set for development to local only.
`final Unit`	`setLocalOnly(Boolean localOnly)`	Version can be set for development to local only.
`final Boolean`	`getShortened()`	Version is shortened for branches and hotfixes with an hash for the string if shortened is true.
`final Unit`	`setShortened(Boolean shortened)`	Version is shortened for branches and hotfixes with an hash for the string if shortened is true.
`final Version`	`getDefaultVersion()`	Default version.
`final Unit`	`setDefaultVersion(Version defaultVersion)`	Default version.
`final String`	`getVersion()`	This is the calculated version of the Git repository.
`final String`	`getContainerVersion()`	This is the calculated containerVersion of the Git repository.
`final String`	`getRevID()`
`final String`	`getPreviousVersion()`	This is the calculated previous version from the Git repository.
`final RevCommit`	`getRevObjectFrom(Version version)`	Calculates the commit for a specified version.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GitVersionService
```
GitVersionService(File directory, VersionType versionType)
```
    creates the service from a directory
    
    Parameters:
    
    directory - local source directory
    
    versionType - default value com.intershop.release.version.VersionType.fourDigits.
  - GitVersionService
```
GitVersionService(File directory)
```
    creates the service from a directory
    
    Parameters:
    
    directory - local source directory
- Method Detail
  - getClient
```
 final Git getClient()
```
    Git client for the existing working copy.
  - getRepository
```
 final Repository getRepository()
```
    Repository for the existing working copy.
  - getBranch
```
 final String getBranch()
```
    This is the current branch name.
  - getMainBranch
```
 final String getMainBranch()
```
    Name of the main branch. Default value is master.
  - setMainBranch
```
 final Unit setMainBranch(String mainBranch)
```
    Name of the main branch. Default value is master.
  - getDevelopBranch
```
 final String getDevelopBranch()
```
    Name of the develop branch. Default value is develop.
  - setDevelopBranch
```
 final Unit setDevelopBranch(String developBranch)
```
    Name of the develop branch. Default value is develop.
  - getHotfixPrefix
```
 final String getHotfixPrefix()
```
    Prefix of a hotfix branch. Default value is hotfix.
  - setHotfixPrefix
```
 final Unit setHotfixPrefix(String hotfixPrefix)
```
    Prefix of a hotfix branch. Default value is hotfix.
  - getFeaturePrefix
```
 final String getFeaturePrefix()
```
    Prefix of a feature branch. Default value is feature.
  - setFeaturePrefix
```
 final Unit setFeaturePrefix(String featurePrefix)
```
    Prefix of a feature branch. Default value is feature.
  - getReleasePrefix
```
 final String getReleasePrefix()
```
    Prefix of a release branch. Default value is release.
  - setReleasePrefix
```
 final Unit setReleasePrefix(String releasePrefix)
```
    Prefix of a release branch. Default value is release.
  - getVersionPrefix
```
 final String getVersionPrefix()
```
    Prefix of a version tag. Default value is version.
  - setVersionPrefix
```
 final Unit setVersionPrefix(String versionPrefix)
```
    Prefix of a version tag. Default value is version.
  - getSeparator
```
 final String getSeparator()
```
    Separator for prefix and branch name. Default value is /.
  - setSeparator
```
 final Unit setSeparator(String separator)
```
    Separator for prefix and branch name. Default value is /.
  - getLocalOnly
```
 final Boolean getLocalOnly()
```
    Version can be set for development to local only.
  - setLocalOnly
```
 final Unit setLocalOnly(Boolean localOnly)
```
    Version can be set for development to local only.
  - getShortened
```
 final Boolean getShortened()
```
    Version is shortened for branches and hotfixes with an hash for the string if shortened is true.
  - setShortened
```
 final Unit setShortened(Boolean shortened)
```
    Version is shortened for branches and hotfixes with an hash for the string if shortened is true.
  - getDefaultVersion
```
 final Version getDefaultVersion()
```
    Default version. Default value is Version.Builder(versionType).build().
  - setDefaultVersion
```
 final Unit setDefaultVersion(Version defaultVersion)
```
    Default version. Default value is Version.Builder(versionType).build().
  - getVersion
```
 final String getVersion()
```
    This is the calculated version of the Git repository.
  - getContainerVersion
```
 final String getContainerVersion()
```
    This is the calculated containerVersion of the Git repository.
  - getRevID
```
 final String getRevID()
```
  - getPreviousVersion
```
 final String getPreviousVersion()
```
    This is the calculated previous version from the Git repository.
  - getRevObjectFrom
```
 final RevCommit getRevObjectFrom(Version version)
```
    Calculates the commit for a specified version.
    
    Parameters:
    
    version - is the a version

Class GitVersionService

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GitVersionService

GitVersionService

Method Detail

getClient

getRepository

getBranch

getMainBranch

setMainBranch

getDevelopBranch

setDevelopBranch

getHotfixPrefix

setHotfixPrefix

getFeaturePrefix

setFeaturePrefix

getReleasePrefix

setReleasePrefix

getVersionPrefix

setVersionPrefix

getSeparator

setSeparator

getLocalOnly

setLocalOnly

getShortened

setShortened

getDefaultVersion

setDefaultVersion

getVersion

getContainerVersion

getRevID

getPreviousVersion

getRevObjectFrom