Package org.eclipse.emf.cdo.common.branch

Interface CDOBranch

All Superinterfaces:
CDOBranchPoint, CDOBranchProvider, CDONameProvider, CDOTimeProvider, Comparable<CDOBranch>, IAdaptable, org.eclipse.net4j.util.container.IContainer<CDOBranch>, org.eclipse.net4j.util.event.INotifier
All Known Subinterfaces:
InternalCDOBranch
public interface CDOBranch extends CDOBranchPoint, CDONameProvider, org.eclipse.net4j.util.container.IContainer<CDOBranch>, Comparable<CDOBranch>, IAdaptable
Represents a stream of changes that is isolated from other streams of changes.

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:

Since:
3.0
Author:
Eike Stepper
No Implement
This interface is not intended to be implemented by clients.
No Extend
This interface is not intended to be extended by clients.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    CDOBranch.BranchDeletedEvent
    An event fired from a branch when it gets deleted.

    Nested classes/interfaces inherited from interface org.eclipse.net4j.util.container.IContainer

    org.eclipse.net4j.util.container.IContainer.Modifiable<E extends Object>, org.eclipse.net4j.util.container.IContainer.Persistable<E extends Object>, org.eclipse.net4j.util.container.IContainer.Persistence<E extends Object>

    Nested classes/interfaces inherited from interface org.eclipse.net4j.util.event.INotifier

    org.eclipse.net4j.util.event.INotifier.INotifier2

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    MAIN_BRANCH_ID
    The fixed ID of the main branch.
    static final String
    MAIN_BRANCH_NAME
    The fixed name of the main branch.
    static final String
    PATH_SEPARATOR
    The string used to separate the segments of branch paths.

    Fields inherited from interface org.eclipse.emf.cdo.common.branch.CDOBranchPoint

    INVALID_DATE, UNSPECIFIED_DATE

  • Method Summary

    Modifier and Type
    Method
    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.
    CDOBranch[]
    delete(org.eclipse.net4j.util.om.monitor.OMMonitor monitor)
    Deletes this branch and all its sub branches.
    void
    fireDeletedEvent()
     
    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
    isDeleted()
    Returns true if this branch has is deleted, false otherwise.
    boolean
    isLocal()
    Returns true if this branch is a local branch, false otherwise.
    boolean
    isMainBranch()
    Returns true if this branch is the main branch, false otherwise.
    void
    rename(String newName)
    Deprecated.
    As of 4.4 use setName(String).
    void
    setName(String name)
     

    Methods inherited from interface org.eclipse.emf.cdo.common.branch.CDOBranchPoint

    getBranch, getTimeStamp

    Methods inherited from interface java.lang.Comparable

    compareTo

    Methods inherited from interface org.eclipse.core.runtime.IAdaptable

    getAdapter

    Methods inherited from interface org.eclipse.net4j.util.container.IContainer

    getElements, isEmpty

    Methods inherited from interface org.eclipse.net4j.util.event.INotifier

    addListener, getListeners, hasListeners, removeListener