org.eclipse.emf.cdo.spi.common.branch.CDOBranchUtil

public final class CDOBranchUtil extends Object

Utilities for interpreting branch ancestry and transporting branch points and ranges. The helpers normalize time stamps against branch bases and rebind branch references to a particular branch manager when data crosses manager boundaries.

Since:: 3.0
Author:: Eike Stepper

Field Summary

Fields

Modifier and Type

Field

Description

static final CDOBranchPoint

AUTO_BRANCH_POINT
Method Summary

Modifier and Type

Method

Description

static CDOBranch

adjustBranch(CDOBranch branch, CDOBranchManager branchManager)

static CDOBranchPoint

adjustBranchPoint(CDOBranchPoint branchPoint, CDOBranchManager branchManager)

static CDOBranchPoint

adjustTime(CDOBranchPoint branchPoint, long deltaMillis)

static CDOBranchPoint

copyBranchPoint(CDOBranchPoint source)

static CDOBranchVersion

copyBranchVersion(CDOBranchVersion source)

static InternalCDOBranchManager

createBranchManager()

static CDOBranchPointRange

createRange(CDOBranchPoint startPoint, CDOBranchPoint endPoint)

static void

forEachBranchInTree(CDOBranch root, Consumer<CDOBranch> consumer)

static void

forEachBranchPoint(CDOBranchPoint branchPoint, boolean considerBranchBases, Predicate<CDOBranchPoint> consumer)

static CDOBranchPoint

getAncestor(CDOBranchPoint point1, CDOBranchPoint point2)

static CDOBranchPoint[]

getPath(CDOBranchPoint point)

static boolean

isContainedBy(CDOBranchPoint contained, CDOBranchPoint container)

Returns true if the first given branch point "contained" is reachable from the second given branch point "container" by following the branch bases upwards, false otherwise.

static CDOBranchPoint

normalizeBranchPoint(CDOBranch branch, long timeStamp)

static CDOBranchPoint

normalizeBranchPoint(CDOBranchPoint branchPoint)

static CDOBranchPoint

readBranchPointOrNull(CDODataInput in)

static CDOBranchPointRange

readRange(CDODataInput in)

static CDOBranchPointRange

readRangeOrNull(CDODataInput in)

static String

sanitizePathName(String pathName)

static void

writeBranchPointOrNull(CDODataOutput out, CDOBranchPoint point)

static void

writeRange(CDODataOutput out, CDOBranchPointRange range)

static void

writeRangeOrNull(CDODataOutput out, CDOBranchPointRange range)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- AUTO_BRANCH_POINT
  
  public static final CDOBranchPoint AUTO_BRANCH_POINT
  
  Since:
  
  4.6
Method Details
- createBranchManager
  
  public static InternalCDOBranchManager createBranchManager()
- createRange
  
  public static CDOBranchPointRange createRange(CDOBranchPoint startPoint, CDOBranchPoint endPoint)
- writeRange
  
  public static void writeRange(CDODataOutput out, CDOBranchPointRange range) throws IOException
  
  Throws:
  
  IOException
  
  Since:
  
  4.6
- readRange
  
  public static CDOBranchPointRange readRange(CDODataInput in) throws IOException
  
  Throws:
  
  IOException
  
  Since:
  
  4.6
- writeRangeOrNull
  
  public static void writeRangeOrNull(CDODataOutput out, CDOBranchPointRange range) throws IOException
  
  Throws:
  
  IOException
  
  Since:
  
  4.6
- readRangeOrNull
  
  public static CDOBranchPointRange readRangeOrNull(CDODataInput in) throws IOException
  
  Throws:
  
  IOException
  
  Since:
  
  4.6
- writeBranchPointOrNull
  
  public static void writeBranchPointOrNull(CDODataOutput out, CDOBranchPoint point) throws IOException
  
  Throws:
  
  IOException
  
  Since:
  
  4.6
- readBranchPointOrNull
  
  public static CDOBranchPoint readBranchPointOrNull(CDODataInput in) throws IOException
  
  Throws:
  
  IOException
  
  Since:
  
  4.6
- copyBranchPoint
  
  public static CDOBranchPoint copyBranchPoint(CDOBranchPoint source)
- copyBranchVersion
  
  public static CDOBranchVersion copyBranchVersion(CDOBranchVersion source)
- adjustTime
  
  public static CDOBranchPoint adjustTime(CDOBranchPoint branchPoint, long deltaMillis)
  
  Since:
  
  4.23
- adjustBranch
  
  public static CDOBranch adjustBranch(CDOBranch branch, CDOBranchManager branchManager)
  
  Since:
  
  4.14
- adjustBranchPoint
  
  public static CDOBranchPoint adjustBranchPoint(CDOBranchPoint branchPoint, CDOBranchManager branchManager)
  
  Since:
  
  4.4
- normalizeBranchPoint
  
  public static CDOBranchPoint normalizeBranchPoint(CDOBranchPoint branchPoint)
  
  Since:
  
  4.4
- normalizeBranchPoint
  
  public static CDOBranchPoint normalizeBranchPoint(CDOBranch branch, long timeStamp)
  
  Since:
  
  4.2
- isContainedBy
  
  public static boolean isContainedBy(CDOBranchPoint contained, CDOBranchPoint container)
  
  Returns true if the first given branch point "contained" is reachable from the second given branch point "container" by following the branch bases upwards, false otherwise.
- getAncestor
  
  public static CDOBranchPoint getAncestor(CDOBranchPoint point1, CDOBranchPoint point2)
- forEachBranchPoint
  
  public static void forEachBranchPoint(CDOBranchPoint branchPoint, boolean considerBranchBases, Predicate<CDOBranchPoint> consumer)
  
  Since:
  
  4.15
- forEachBranchInTree
  
  public static void forEachBranchInTree(CDOBranch root, Consumer<CDOBranch> consumer)
  
  Since:
  
  4.15
- getPath
  
  public static CDOBranchPoint[] getPath(CDOBranchPoint point)
- sanitizePathName
  
  public static String sanitizePathName(String pathName)
  
  Since:
  
  4.12

Class CDOBranchUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

AUTO_BRANCH_POINT

Method Details

createBranchManager

createRange

writeRange

readRange

writeRangeOrNull

readRangeOrNull

writeBranchPointOrNull

readBranchPointOrNull

copyBranchPoint

copyBranchVersion

adjustTime

adjustBranch

adjustBranchPoint

normalizeBranchPoint

normalizeBranchPoint

isContainedBy

getAncestor

forEachBranchPoint

forEachBranchInTree

getPath

sanitizePathName