org.chronos.chronosphere.api

Interface SphereBranch

All Known Implementing Classes:

SphereBranchImpl

public interface SphereBranch

A SphereBranch represents a single stream of changes in the versioning system.

Branches work much like in document versioning systems, such as GIT or SVN. Every branch has an "origin" (or "parent") branch from which it was created, as well as a "branching timestamp" that reflects the point in time from which this branch was created. There is one special branch, which is the master branch. It is the transitive origin of all other branches. It always has the same name, an origin of null, and a branching timestamp of zero. Unlike other branches, the master branch is created by default and always exists.

Method Summary

Modifier and Type	Method and Description
long	getBranchingTimestamp() Returns the timestamp at which this branch was created from the origin (parent) branch.
java.lang.String	getName() Returns the name of this branch, which also acts as its unique identifier.
long	getNow() Returns the "now" timestamp on this branch, i.e. the timestamp at which the last full commit was successfully executed.
SphereBranch	getOrigin() Returns the branch from which this branch originates.
java.util.List<SphereBranch>	getOriginsRecursive() Returns the list of direct and transitive origin branches.

Method Detail

getName

java.lang.String getName()

Returns the name of this branch, which also acts as its unique identifier.

Returns:

The branch name. Never null. Branch names are unique.

getOrigin

SphereBranch getOrigin()

Returns the branch from which this branch originates.

Returns:

The origin (parent) branch. May be null if this branch is the master branch.

getBranchingTimestamp

long getBranchingTimestamp()

Returns the timestamp at which this branch was created from the origin (parent) branch.

Returns:

The branching timestamp. Never negative.

getOriginsRecursive

java.util.List<SphereBranch> getOriginsRecursive()

Returns the list of direct and transitive origin branches.

The first entry in the list will always be the master branch. The remaining entries are the descendants of the previous branch in the list which are also direct or transitive origins of the current branch.

For example, if there were the following branching actions:

1. master is forked into new branch A
2. A is forked into new branch B
3. B is forked into new branch C

... and C.getOriginsRecursive() is invoked, then the returned list will consist of [master, A, B] (in exactly this order).

Returns:

The list of origin branches. Will be empty for the master branch, and will start with the master branch for all other branches. Never null. The returned list is a calculated object which may freely be modified without changing any internal state.

getNow

long getNow()

Returns the "now" timestamp on this branch, i.e. the timestamp at which the last full commit was successfully executed.

Returns:

The "now" timestamp. The minimum is the branching timestamp (or zero for the master branch). Never negative.