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

Class ApplyDiff

  • All Implemented Interfaces:
    NodeStateDiff
    public class ApplyDiff
extends java.lang.Object
implements NodeStateDiff
    A node state diff handler that applies all reported changes as-is to the given node builder. No conflict detection or resolution is attempted. The main use case for this class is to call all the NodeBuilder methods necessary to go from a given base state to any given target state.

    The expected usage pattern looks like this: 

     NodeState base = ...;
 NodeState target = ...;
 NodeBuilder builder = base.builder();
 target.compareAgainstBaseState(base, new ApplyDiff(builder));
 assertEquals(target, builder.getNodeState());

    Alternatively, the apply(NodeState) method can be used to set the content of a given builder: 

     NodeBuilder builder = ...;
 NodeState target = ...;
 new ApplyDiff(builder).apply(target);
 assertEquals(target, builder.getNodeState());

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void apply​(NodeState target)  
      boolean childNodeAdded​(java.lang.String name, NodeState after)
      Called for all added child nodes.
      boolean childNodeChanged​(java.lang.String name, NodeState before, NodeState after)
      Called for all child nodes that may contain changes between the before and after states.
      boolean childNodeDeleted​(java.lang.String name, NodeState before)
      Called for all deleted child nodes.
      boolean propertyAdded​(org.apache.jackrabbit.oak.api.PropertyState after)
      Called for all added properties.
      boolean propertyChanged​(org.apache.jackrabbit.oak.api.PropertyState before, org.apache.jackrabbit.oak.api.PropertyState after)
      Called for all changed properties.
      boolean propertyDeleted​(org.apache.jackrabbit.oak.api.PropertyState before)
      Called for all deleted properties.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • apply

        public void apply​(NodeState target)

      • propertyAdded

        public boolean propertyAdded​(org.apache.jackrabbit.oak.api.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​(org.apache.jackrabbit.oak.api.PropertyState before,
                               org.apache.jackrabbit.oak.api.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​(org.apache.jackrabbit.oak.api.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​(java.lang.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​(java.lang.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​(java.lang.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.