org.eclipse.emf.cdo.spi.common.revision.RevisionInfo

Direct Known Subclasses:: RevisionInfo.Available, RevisionInfo.Missing

public abstract class RevisionInfo extends Object

Request and response record used by the revision-loading protocol for one object at a branch point. Concrete variants distinguish a directly available revision, an inherited or detached synthetic result, and an object missing from that history; the record also carries the loaded result back to the revision manager.

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

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

RevisionInfo.Available

Common request form for an object revision found in branch history.

static class

RevisionInfo.Missing

Revision lookup result for an object with no state available at the requested history point.

static enum

RevisionInfo.Type

Wire-level category for a revision lookup result.
Constructor Summary

Constructors

Modifier

Constructor

Description

protected

RevisionInfo(CDOID id, CDOBranchPoint requestedBranchPoint)

protected

RevisionInfo(CDODataInput in, CDOBranchPoint requestedBranchPoint)
Method Summary

Modifier and Type

Method

Description

protected InternalCDORevision

doReadResult(CDODataInput in)

Deprecated.
Not called anymore by the framework

protected void

doWriteResult(CDODataOutput out, InternalCDORevision revision, int referenceChunk)

Deprecated.
Not called anymore by the framework

void

execute(InternalCDORevisionManager revisionManager, int referenceChunk)

void

execute(InternalCDORevisionManager revisionManager, CDORevisionManager.Request.Config config)

Executes this revision request with the canonical request configuration.

final CDOID

getID()

final CDOBranchPoint

getRequestedBranchPoint()

InternalCDORevision

getResult()

SyntheticCDORevision

getSynthetic()

abstract RevisionInfo.Type

getType()

abstract boolean

isLoadNeeded()

void

processResult(InternalCDORevisionManager revisionManager, List<CDORevision> results, SyntheticCDORevision[] synthetics, int i)

static RevisionInfo

read(CDODataInput in, CDOBranchPoint requestedBranchPoint)

void

readResult(CDODataInput in)

static InternalCDORevision

readResult(CDODataInput in, CDOID id, CDOBranch branch)

protected void

readRevision(CDODataInput in)

void

setResult(InternalCDORevision result)

void

setSynthetic(SyntheticCDORevision synthetic)

String

toLongString()

String

toString()

void

write(CDODataOutput out)

void

writeResult(CDODataOutput out, int referenceChunk)

Deprecated.
Not called anymore by the framework

void

writeResult(CDODataOutput out, int referenceChunk, CDOBranchPoint securityContext)

static void

writeResult(CDODataOutput out, InternalCDORevision revision, boolean writePointerTarget, int referenceChunk, CDOBranchPoint securityContext)

static void

writeResult(CDODataOutput out, InternalCDORevision revision, int referenceChunk)

Deprecated.
As of 4.1 call writeResult(CDODataOutput, InternalCDORevision, int, CDOBranchPoint).

static void

writeResult(CDODataOutput out, InternalCDORevision revision, int referenceChunk, CDOBranchPoint securityContext)

Deprecated.
As of 4.15 call writeResult(CDODataOutput, InternalCDORevision, boolean, int, CDOBranchPoint).

protected void

writeRevision(CDODataOutput out, int referenceChunk)

Deprecated.
Not called anymore by the framework.

protected void

writeRevision(CDODataOutput out, int referenceChunk, CDOBranchPoint securityContext)

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

Constructor Details
- RevisionInfo
  
  protected RevisionInfo(CDOID id, CDOBranchPoint requestedBranchPoint)
- RevisionInfo
  
  protected RevisionInfo(CDODataInput in, CDOBranchPoint requestedBranchPoint) throws IOException
  
  Throws:
  
  IOException
Method Details
- getType
  
  public abstract RevisionInfo.Type getType()
- getID
  
  public final CDOID getID()
- getRequestedBranchPoint
  
  public final CDOBranchPoint getRequestedBranchPoint()
- getResult
  
  public InternalCDORevision getResult()
- setResult
  
  public void setResult(InternalCDORevision result)
- getSynthetic
  
  public SyntheticCDORevision getSynthetic()
- setSynthetic
  
  public void setSynthetic(SyntheticCDORevision synthetic)
- isLoadNeeded
  
  public abstract boolean isLoadNeeded()
- write
  
  public void write(CDODataOutput out) throws IOException
  
  Throws:
  
  IOException
- toString
  
  public String toString()
  
  Overrides:
  
  toString in class Object
- toLongString
  
  public String toLongString()
  
  Since:
  
  4.15
- read
  
  public static RevisionInfo read(CDODataInput in, CDOBranchPoint requestedBranchPoint) throws IOException
  
  Throws:
  
  IOException
- execute
  
  public void execute(InternalCDORevisionManager revisionManager, int referenceChunk)
- execute
  
  public void execute(InternalCDORevisionManager revisionManager, CDORevisionManager.Request.Config config)
  
  Executes this revision request with the canonical request configuration.
  This overload lets protocol batches share an immutable configuration across their revision requests while keeping synthetic revisions on their separate result channel.
  
  Parameters:
  
  revisionManager - the manager that loads this revision
  
  config - the immutable options that control lookup and collection loading
  
  Since:
  
  4.29
- writeResult
  
  @Deprecated public void writeResult(CDODataOutput out, int referenceChunk) throws IOException
  
  Deprecated.
  Not called anymore by the framework
  
  Throws:
  
  IOException
- writeResult
  
  public void writeResult(CDODataOutput out, int referenceChunk, CDOBranchPoint securityContext) throws IOException
  
  Throws:
  
  IOException
  
  Since:
  
  4.1
- readResult
  
  public void readResult(CDODataInput in) throws IOException
  
  Throws:
  
  IOException
- processResult
  
  public void processResult(InternalCDORevisionManager revisionManager, List<CDORevision> results, SyntheticCDORevision[] synthetics, int i)
- writeRevision
  
  @Deprecated protected void writeRevision(CDODataOutput out, int referenceChunk) throws IOException
  
  Deprecated.
  Not called anymore by the framework.
  
  Throws:
  
  IOException
- writeRevision
  
  protected void writeRevision(CDODataOutput out, int referenceChunk, CDOBranchPoint securityContext) throws IOException
  
  Throws:
  
  IOException
  
  Since:
  
  4.1
- readRevision
  
  protected void readRevision(CDODataInput in) throws IOException
  
  Throws:
  
  IOException
- writeResult
  
  @Deprecated public static void writeResult(CDODataOutput out, InternalCDORevision revision, int referenceChunk) throws IOException
  
  Deprecated.
  As of 4.1 call writeResult(CDODataOutput, InternalCDORevision, int, CDOBranchPoint).
  
  Throws:
  
  IOException
  
  Since:
  
  4.0
- writeResult
  
  @Deprecated public static void writeResult(CDODataOutput out, InternalCDORevision revision, int referenceChunk, CDOBranchPoint securityContext) throws IOException
  
  Deprecated.
  As of 4.15 call writeResult(CDODataOutput, InternalCDORevision, boolean, int, CDOBranchPoint).
  
  Throws:
  
  IOException
  
  Since:
  
  4.1
- writeResult
  
  public static void writeResult(CDODataOutput out, InternalCDORevision revision, boolean writePointerTarget, int referenceChunk, CDOBranchPoint securityContext) throws IOException
  
  Throws:
  
  IOException
  
  Since:
  
  4.15
  
  No Reference
  
  This method is not intended to be referenced by clients.
- readResult
  
  public static InternalCDORevision readResult(CDODataInput in, CDOID id, CDOBranch branch) throws IOException
  
  Throws:
  
  IOException
  
  Since:
  
  4.0
- doWriteResult
  
  @Deprecated protected void doWriteResult(CDODataOutput out, InternalCDORevision revision, int referenceChunk) throws IOException
  
  Deprecated.
  Not called anymore by the framework
  
  Throws:
  
  IOException
- doReadResult
  
  @Deprecated protected InternalCDORevision doReadResult(CDODataInput in) throws IOException
  
  Deprecated.
  Not called anymore by the framework
  
  Throws:
  
  IOException

Class RevisionInfo

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Details

RevisionInfo

RevisionInfo

Method Details

getType

getID

getRequestedBranchPoint

getResult

setResult

getSynthetic

setSynthetic

isLoadNeeded

write

toString

toLongString

read

execute

execute

writeResult

writeResult

readResult

processResult

writeRevision

writeRevision

readRevision

writeResult

writeResult

writeResult

readResult

doWriteResult

doReadResult