org.chronos.chronosphere.api

Interface ChronoSphereBranchManager

All Known Implementing Classes:

ChronoSphereBranchManagerImpl

public interface ChronoSphereBranchManager

The branch manager is responsible for creating and maintaining branches in a ChronoSphere repository.

You can get an instance of this class via ChronoSphere.getBranchManager().

Method Summary

Modifier and Type	Method and Description
SphereBranch	createBranch(java.lang.String branchName) Creates a new child of the master branch with the given name.
SphereBranch	createBranch(java.lang.String branchName, long branchingTimestamp) Creates a new child of the master branch with the given name.
SphereBranch	createBranch(java.lang.String parentName, java.lang.String newBranchName) Creates a new child of the given parent branch with the given name.
SphereBranch	createBranch(java.lang.String parentName, java.lang.String newBranchName, long branchingTimestamp) Creates a new child of the given parent branch with the given name.
boolean	existsBranch(java.lang.String branchName) Checks if a branch with the given name exists or not.
SphereBranch	getBranch(java.lang.String branchName) Returns the branch with the given name.
java.util.Set<SphereBranch>	getBranches() Returns the set of all existing branches.
java.util.Set<java.lang.String>	getBranchNames() Returns the name of all existing branches.
default SphereBranch	getMasterBranch() Returns the master branch.

Method Detail

createBranch

SphereBranch createBranch(java.lang.String branchName)

Creates a new child of the master branch with the given name.

This will use the head revision as the base revision for the new branch.

Parameters:

branchName - The name of the new branch. Must not be null. Must not refer to an already existing branch. Branch names must be unique.

Returns:

The newly created branch. Never null.

See Also:

createBranch(String, long), createBranch(String, String), createBranch(String, String, long)

createBranch

SphereBranch createBranch(java.lang.String branchName,
                          long branchingTimestamp)

Creates a new child of the master branch with the given name.

Parameters:

branchName - The name of the new branch. Must not be null. Must not refer to an already existing branch. Branch names must be unique.

branchingTimestamp - The timestamp at which to branch away from the master branch. Must not be negative. Must be less than or equal to the timestamp of the latest commit on the master branch.

Returns:

The newly created branch. Never null.

See Also:

createBranch(String), createBranch(String, String), createBranch(String, String, long)

createBranch

SphereBranch createBranch(java.lang.String parentName,
                          java.lang.String newBranchName)

Creates a new child of the given parent branch with the given name.

This will use the head revision of the given parent branch as the base revision for the new branch.

Parameters:

parentName - The name of the parent branch. Must not be null. Must refer to an existing branch.

newBranchName - The name of the new child branch. Must not be null. Must not refere to an already existing branch. Branch names must be unique.

Returns:

The newly created branch. Never null.

See Also:

createBranch(String), createBranch(String, long), createBranch(String, String, long)

createBranch

SphereBranch createBranch(java.lang.String parentName,
                          java.lang.String newBranchName,
                          long branchingTimestamp)

Creates a new child of the given parent branch with the given name.

Parameters:

parentName - The name of the parent branch. Must not be null. Must refer to an existing branch.

newBranchName - The name of the new child branch. Must not be null. Must not refere to an already existing branch. Branch names must be unique.

branchingTimestamp - The timestamp at which to branch away from the parent branch. Must not be negative. Must be less than or equal to the timestamp of the latest commit on the parent branch.

Returns:

The newly created branch. Never null.

See Also:

createBranch(String), createBranch(String, long), createBranch(String, String, long)

existsBranch

boolean existsBranch(java.lang.String branchName)

Checks if a branch with the given name exists or not.

Parameters:

branchName - The branch name to check. Must not be null.

Returns:

true if there is an existing branch with the given name, otherwise false.

getBranch

SphereBranch getBranch(java.lang.String branchName)

Returns the branch with the given name.

Parameters:

branchName - The name of the branch to retrieve. Must not be null. Must refer to an existing branch.

Returns:

The branch with the given name. Never null.

getMasterBranch

default SphereBranch getMasterBranch()

Returns the master branch.

Returns:

The master branch. Never null.

getBranchNames

java.util.Set<java.lang.String> getBranchNames()

Returns the name of all existing branches.

Returns:

An unmodifiable view on the names of all branches. May be empty, but never null.

getBranches

java.util.Set<SphereBranch> getBranches()

Returns the set of all existing branches.

Returns:

An unmodifiable view on the set of all branches. May be empty, but never null.