Package org.apache.jackrabbit.oak.json

Class JsopDiff

java.lang.Object

org.apache.jackrabbit.oak.json.JsopDiff

All Implemented Interfaces:

NodeStateDiff

public class JsopDiff
extends Object
implements NodeStateDiff

TODO document

Constructor Summary

Constructors

Constructor	Description
JsopDiff()
JsopDiff(String path, int depth)
JsopDiff(BlobSerializer blobs)
JsopDiff(BlobSerializer blobs, String path)

Method Summary

Modifier and Type	Method	Description
boolean	childNodeAdded(String name, NodeState after)	Called for all added child nodes.
boolean	childNodeChanged(String name, NodeState before, NodeState after)	Called for all child nodes that may contain changes between the before and after states.
boolean	childNodeDeleted(String name, NodeState before)	Called for all deleted child nodes.
static String	diffToJsop(NodeState before, NodeState after)	Create the JSOP diff between before and after for debugging purposes.
boolean	propertyAdded(PropertyState after)	Called for all added properties.
boolean	propertyChanged(PropertyState before, PropertyState after)	Called for all changed properties.
boolean	propertyDeleted(PropertyState before)	Called for all deleted properties.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JsopDiff

public JsopDiff(BlobSerializer blobs,
                String path)

JsopDiff

public JsopDiff(BlobSerializer blobs)

JsopDiff

public JsopDiff(String path,
                int depth)

JsopDiff

public JsopDiff()

Method Detail

diffToJsop

public static String diffToJsop(NodeState before,
                                NodeState after)

Create the JSOP diff between before and after for debugging purposes.

This method does not store binaries but returns them inlined in the format Blob{...}, where the ... is implementation-dependent - typically the SHA256 hash of the binary.

Parameters:

before - before node state

after - after node state

Returns:

jsop diff between before and after

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.

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.

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.

toString

public String toString()

Overrides:

toString in class Object