Package sonia.scm.repository

Class Branch

java.lang.Object

sonia.scm.repository.Branch

All Implemented Interfaces:

Serializable, Validateable

public final class Branch
extends Object
implements Serializable, Validateable

Represents a branch in a repository.

Since:

1.18

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Pattern	VALID_BRANCH_NAME_PATTERN
static final String	VALID_BRANCH_NAMES

Method Summary

Modifier and Type	Method	Description
static Branch	defaultBranch(String name, String revision)	Deprecated. Use defaultBranch(String, String, Long) instead to set the date of the last commit, too.
static Branch	defaultBranch(String name, String revision, Long lastCommitDate)	Deprecated. Use defaultBranch(String, String, Long, Person) instead to set the author of the last commit, too.
static Branch	defaultBranch(String name, String revision, Long lastCommitDate, Person lastCommitter)
boolean	equals(Object obj)
Optional<Long>	getLastCommitDate()	The date of the commit this branch points to, if this was computed (can be empty).
Person	getLastCommitter()	The author of the last commit this branch points to.
String	getName()	Returns the name of the branch
String	getRevision()	Returns the latest revision of the branch.
int	hashCode()
boolean	isDefaultBranch()	Flag whether this branch is configured as the default branch.
boolean	isStale()
boolean	isValid()	Returns true if the object is valid.
static Branch	normalBranch(String name, String revision)	Deprecated. Use normalBranch(String, String, Long, Person) instead to set the date of the last commit, too.
static Branch	normalBranch(String name, String revision, Long lastCommitDate)	Deprecated. Use normalBranch(String, String, Long, Person) instead to set the author of the last commit, too.
static Branch	normalBranch(String name, String revision, Long lastCommitDate, Person lastCommitter)
void	setStale(boolean stale)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

VALID_BRANCH_NAMES

public static final String VALID_BRANCH_NAMES

See Also:

• Constant Field Values

VALID_BRANCH_NAME_PATTERN

public static final Pattern VALID_BRANCH_NAME_PATTERN

Method Details

normalBranch

@Deprecated
public static Branch normalBranch(String name,
 String revision)

Deprecated.

Use normalBranch(String, String, Long, Person) instead to set the date of the last commit, too.

normalBranch

@Deprecated
public static Branch normalBranch(String name,
 String revision,
 Long lastCommitDate)

Deprecated.

Use normalBranch(String, String, Long, Person) instead to set the author of the last commit, too.

normalBranch

public static Branch normalBranch(String name,
 String revision,
 Long lastCommitDate,
 Person lastCommitter)

defaultBranch

@Deprecated
public static Branch defaultBranch(String name,
 String revision)

Deprecated.

Use defaultBranch(String, String, Long) instead to set the date of the last commit, too.

defaultBranch

@Deprecated
public static Branch defaultBranch(String name,
 String revision,
 Long lastCommitDate)

Deprecated.

Use defaultBranch(String, String, Long, Person) instead to set the author of the last commit, too.

defaultBranch

public static Branch defaultBranch(String name,
 String revision,
 Long lastCommitDate,
 Person lastCommitter)

setStale

public void setStale(boolean stale)

isValid

public boolean isValid()

Description copied from interface: Validateable

Returns true if the object is valid.

Specified by:

isValid in interface Validateable

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getName

public String getName()

Returns the name of the branch

Returns:

name of the branch

getRevision

public String getRevision()

Returns the latest revision of the branch.

Returns:

latest revision of branch

isDefaultBranch

public boolean isDefaultBranch()

Flag whether this branch is configured as the default branch.

getLastCommitDate

public Optional<Long> getLastCommitDate()

The date of the commit this branch points to, if this was computed (can be empty).

Since:

2.11.0

getLastCommitter

public Person getLastCommitter()

The author of the last commit this branch points to.

Since:

2.28.0

isStale

public boolean isStale()