Package org.apache.jackrabbit.oak.spi.state

Class AbstractRebaseDiff

java.lang.Object
org.apache.jackrabbit.oak.spi.state.AbstractRebaseDiff
All Implemented Interfaces:
NodeStateDiff
Direct Known Subclasses:
ConflictAnnotatingRebaseDiff
public abstract class AbstractRebaseDiff extends Object implements NodeStateDiff
AbstractRebaseDiff serves as base for rebase implementations. It implements a NodeStateDiff, which performs the conflict handling as defined in NodeStore.rebase(NodeBuilder) on the Oak SPI state level.

Intended use of this class is to re-base a branched version of the node state tree. Given below situation: 

     + head (master)
     |
     | + branch
     |/
     + base
     |
The current state on the master branch is head and a branch was created at base. The current state on the branch is branch. Re-basing branch to the current head works as follows: 
     NodeState head = ...
     NodeState branch = ...
     NodeState base = ...
     NodeBuilder builder = new MemoryNodeBuilder(head);
     branch.compareAgainstBaseState(base, new MyRebaseDiff(builder));
     branch = builder.getNodeState();
The result is: 
       + branch
      /
     + head (master)
     |

Conflicts during rebase cause calls to the various abstracts conflict resolution methods of this class. Concrete subclasses of this class need to implement these methods for handling such conflicts.

  • Method Details

    • propertyAdded

      public boolean propertyAdded(PropertyState after)
      Description copied from interface: NodeStateDiff
      Called for all added properties.
      Specified by:
      propertyAdded in interface NodeStateDiff
      Parameters:
      after - property state after the change
      Returns:
      true to continue the comparison, false to abort. Abort will stop comparing completely, that means sibling nodes and sibling nodes of all parents are not further compared.

    • propertyChanged

      public boolean propertyChanged(PropertyState before, PropertyState after)
      Description copied from interface: NodeStateDiff
      Called for all changed properties. The names of the given two property states are guaranteed to be the same.
      Specified by:
      propertyChanged in interface NodeStateDiff
      Parameters:
      before - property state before the change
      after - property state after the change
      Returns:
      true to continue the comparison, false to abort. Abort will stop comparing completely, that means sibling nodes and sibling nodes of all parents are not further compared.

    • propertyDeleted

      public boolean propertyDeleted(PropertyState before)
      Description copied from interface: NodeStateDiff
      Called for all deleted properties.
      Specified by:
      propertyDeleted in interface NodeStateDiff
      Parameters:
      before - property state before the change
      Returns:
      true to continue the comparison, false to abort. Abort will stop comparing completely, that means sibling nodes and sibling nodes of all parents are not further compared.

    • childNodeAdded

      public boolean childNodeAdded(String name, NodeState after)
      Description copied from interface: NodeStateDiff
      Called for all added child nodes.
      Specified by:
      childNodeAdded in interface NodeStateDiff
      Parameters:
      name - name of the added child node
      after - child node state after the change
      Returns:
      true to continue the comparison, false to abort. Abort will stop comparing completely, that means sibling nodes and sibling nodes of all parents are not further compared.

    • childNodeChanged

      public boolean childNodeChanged(String name, NodeState before, NodeState after)
      Description copied from interface: NodeStateDiff
      Called for all child nodes that may contain changes between the before and after states. The comparison implementation is expected to make an effort to avoid calling this method on child nodes under which nothing has changed.
      Specified by:
      childNodeChanged in interface NodeStateDiff
      Parameters:
      name - name of the changed child node
      before - child node state before the change
      after - child node state after the change
      Returns:
      true to continue the comparison, false to abort. Abort will stop comparing completely, that means sibling nodes and sibling nodes of all parents are not further compared.

    • childNodeDeleted

      public boolean childNodeDeleted(String name, NodeState before)
      Description copied from interface: NodeStateDiff
      Called for all deleted child nodes.
      Specified by:
      childNodeDeleted in interface NodeStateDiff
      Parameters:
      name - name of the deleted child node
      before - child node state before the change
      Returns:
      true to continue the comparison, false to abort. Abort will stop comparing completely, that means sibling nodes and sibling nodes of all parents are not further compared.