org.unbrokendome.gradle.plugins.gitversion.core

Interface BranchPoint

All Superinterfaces:

HasObjectId

All Known Implementing Classes:

BranchPointImpl

public interface BranchPoint
extends HasObjectId

A point in the commit history where a branch was created off another branch. This is used for the result of the GitOperations.branchPoint(java.lang.String...) methods.

Method Summary

Modifier and Type	Method and Description
GitCommit	getCommit() Gets the commit from which the branch was created.
default java.lang.String	getId() Gets the commit ID.
MatcherFacade	getMatches() If a regular expression pattern was used to find this branch point, gets the matches from the branch name.
GitBranch	getOtherBranch() Gets the other branch which was forked off here.
default java.lang.String	getOtherBranchName() Gets the name of the other branch which was forked off here.

Methods inherited from interface org.unbrokendome.gradle.plugins.gitversion.model.HasObjectId

id

Method Detail

getCommit

@Nonnull
GitCommit getCommit()

Gets the commit from which the branch was created.

Returns:

the Git commit

getOtherBranch

@Nonnull
GitBranch getOtherBranch()

Gets the other branch which was forked off here.

Returns:

the other branch

getOtherBranchName

@Nonnull
default java.lang.String getOtherBranchName()

Gets the name of the other branch which was forked off here.

Returns:

the (short) name of the other branch

getMatches

@Nonnull
MatcherFacade getMatches()

If a regular expression pattern was used to find this branch point, gets the matches from the branch name.

Returns:

the matches

getId

@Nonnull
default java.lang.String getId()

Gets the commit ID.

Specified by:

getId in interface HasObjectId

Returns:

the commit ID