public interface CDOBranch extends IContainer<CDOBranch>, Comparable<CDOBranch>
A branch starts at a fixed base
point and ends at a floating head
point.
Between these two points there can be a number of other branch points
:
Commit infos
are points in a branch that represent commit operations.
Branch tags
are named points in a branch.
Base points
of sub branches of a branch.
IContainer.Modifiable<E>
Modifier and Type | Field and Description |
---|---|
static int |
MAIN_BRANCH_ID
The fixed ID of the
main branch . |
static String |
MAIN_BRANCH_NAME
The fixed name of the
main branch . |
static String |
PATH_SEPARATOR
The string used to separate the segments of branch paths.
|
Modifier and Type | Method and Description |
---|---|
CDOBranch |
createBranch(String name)
Creates a sub branch of this branch with the given name,
based at the current time . |
CDOBranch |
createBranch(String name,
long timeStamp)
Creates a sub branch of this branch with the given name,
based at the branch point in this branch with the given time stamp. |
CDOBranchPoint |
getBase()
Returns the immutable base branch point of this branch, the point in the parent branch that marks the creation of
this branch.
|
CDOBranchPoint[] |
getBasePath()
Returns an array of the
base branch points starting from the base of the
main branch down to and including the base of this branch. |
CDOBranch |
getBranch(String path)
Returns the sub branch of this branch with the given relative path, or
null if no sub branch with this
path exists in this branch. |
CDOBranch[] |
getBranches()
Returns an array of the sub branches of this branch, never
null . |
CDOBranchManager |
getBranchManager()
Returns the branch manager that manages this branch, never
null . |
CDOBranchPoint |
getHead()
Returns the floating end point of this branch, a pair of this branch and the fixed special time stamp
unspecified . |
int |
getID()
Returns the ID of this branch.
|
String |
getName()
Returns the name of this branch as specified when it was created with
createBranch() or MAIN_BRANCH_NAME if this branch is the main
branch . |
String |
getPathName()
Returns the fully qualified path name of this branch, a concatenation of the names of all branches from the
main branch to this branch, separated by slashes
("/" characters). |
CDOBranchPoint |
getPoint(long timeStamp)
Returns the branch point in this branch with the given time stamp.
|
CDOBranchVersion |
getVersion(int version)
Returns the branch version in this branch with the given version number.
|
boolean |
isLocal()
Returns
true if this branch is a local branch, false otherwise. |
boolean |
isMainBranch()
|
getElements, isEmpty
addListener, getListeners, hasListeners, removeListener
compareTo
static final int MAIN_BRANCH_ID
main branch
.static final String MAIN_BRANCH_NAME
main branch
.static final String PATH_SEPARATOR
boolean isMainBranch()
boolean isLocal()
int getID()
The main branch
has the fixed ID 0 (zero), Local
branches
have negative IDs and normal branches have positive IDs.
String getName()
createBranch()
or MAIN_BRANCH_NAME
if this branch is the main
branch
.String getPathName()
main branch
to this branch, separated by slashes
("/" characters). Example: "MAIN/team1/smith".CDOBranchPoint[] getBasePath()
base
branch points starting from the base of the
main branch
down to and including the base of this branch.CDOBranchPoint getBase()
The base of the main branch
marks the creation of the
repository
.
getHead()
,
getPoint(long)
CDOBranchPoint getHead()
unspecified
.getBase()
,
getPoint(long)
CDOBranchPoint getPoint(long timeStamp)
This factory method never returns null
.
getBase()
,
getHead()
,
getVersion(int)
CDOBranchVersion getVersion(int version)
This factory method never returns null
.
getPoint(long)
CDOBranchManager getBranchManager()
null
.CDOBranch[] getBranches()
null
.CDOBranch getBranch(String path)
null
if no sub branch with this
path exists in this branch.
The path name is the concatenation of the names of all branches from a direct sub branch of this branch, separated
by slashes
("/" characters). Example: "team1/smith".
CDOBranch createBranch(String name, long timeStamp)
based
at the branch point
in this branch with the given time stamp.
name
- The name of the sub branch to be created. It must not contain the path separator
character (slash).timeStamp
- The time stamp in this branch that the sub branch to be created is supposed to be based
at
. It must not be before the base time stamp of this branch and it must be different from the fixed
special time stamp unspecified
createBranch(String)
CDOBranch createBranch(String name)
based
at the current time
.Copyright (c) 2011, 2012 Eike Stepper (Berlin, Germany) and others.