org.apache.jackrabbit.oak.plugins.document

Class DocumentNodeState

java.lang.Object

org.apache.jackrabbit.oak.spi.state.AbstractNodeState

org.apache.jackrabbit.oak.plugins.document.AbstractDocumentNodeState

org.apache.jackrabbit.oak.plugins.document.DocumentNodeState

All Implemented Interfaces:

CacheValue, NodeState

public class DocumentNodeState
extends AbstractDocumentNodeState
implements CacheValue

A NodeState implementation for the DocumentNodeStore.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DocumentNodeState.BundlingContext
static class	DocumentNodeState.Children A list of children for a node.

Field Summary

Fields

Modifier and Type	Field and Description
static DocumentNodeState.Children	NO_CHILDREN

Fields inherited from interface org.apache.jackrabbit.oak.spi.state.NodeState

EXISTS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DocumentNodeState(@NotNull DocumentNodeStore store, @NotNull String path, @Nullable RevisionVector lastRevision, @Nullable RevisionVector rootRevision, boolean fromExternalChange, DocumentNodeState.BundlingContext bundlingContext)

Method Summary

Modifier and Type	Method and Description
String	asString()
@NotNull NodeBuilder	builder() Returns a builder for constructing a new node state based on this state, i.e.
boolean	exists() Checks whether this node exists.
@NotNull DocumentNodeState	fromExternalChange()
static DocumentNodeState	fromString(DocumentNodeStore store, String s)
Iterable<DocumentNodeState>	getAllBundledNodesStates()
Set<String>	getBundledChildNodeNames()
@NotNull NodeState	getChildNode(@NotNull String name) Returns the named, possibly non-existent, child node.
long	getChildNodeCount(long max) Returns the number of iterable child nodes of this node.
@NotNull Iterable<? extends ChildNodeEntry>	getChildNodeEntries() Returns the iterable child node entries of this instance.
RevisionVector	getLastRevision()
int	getMemory() The estimated amount of memory used by this object, in bytes.
protected NodeStateDiffer	getNodeStateDiffer()
String	getPath()
@NotNull Iterable<? extends PropertyState>	getProperties() Returns an iterable of the properties of this node.
PropertyState	getProperty(@NotNull String name) Returns the named property, or null if no such property exists.
long	getPropertyCount() Returns the number of properties of this node.
@NotNull RevisionVector	getRootRevision() Returns the root revision for this node state.
boolean	hasChildNode(@NotNull String name) Checks whether the named child node exists.
boolean	hasNoChildren()
boolean	hasOnlyBundledChildren()
boolean	hasProperty(@NotNull String name) Checks whether the named property exists.
boolean	isFromExternalChange()
String	toString() Returns a string representation of this node state.
DocumentNodeState	withRootRevision(@NotNull RevisionVector root, boolean externalChange) Creates a copy of this DocumentNodeState with the rootRevision set to the given root revision.

Methods inherited from class org.apache.jackrabbit.oak.plugins.document.AbstractDocumentNodeState

compareAgainstBaseState, equals

Methods inherited from class org.apache.jackrabbit.oak.spi.state.AbstractNodeState

checkValidName, compareAgainstBaseState, comparePropertiesAgainstBaseState, count, equals, getBoolean, getBoolean, getChildNodeNames, getLong, getLong, getName, getName, getNames, getNames, getString, getString, getStrings, getStrings, hashCode, isValidName, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_CHILDREN

public static final DocumentNodeState.Children NO_CHILDREN

Constructor Detail

DocumentNodeState

protected DocumentNodeState(@NotNull
                            @NotNull DocumentNodeStore store,
                            @NotNull
                            @NotNull String path,
                            @Nullable
                            @Nullable RevisionVector lastRevision,
                            @Nullable
                            @Nullable RevisionVector rootRevision,
                            boolean fromExternalChange,
                            DocumentNodeState.BundlingContext bundlingContext)

Method Detail

withRootRevision

public DocumentNodeState withRootRevision(@NotNull
                                          @NotNull RevisionVector root,
                                          boolean externalChange)

Creates a copy of this DocumentNodeState with the rootRevision set to the given root revision. This method returns this instance if the given root revision is the same as the one in this instance and the fromExternalChange flags are equal.

Specified by:

withRootRevision in class AbstractDocumentNodeState

Parameters:

root - the root revision for the copy of this node state.

externalChange - if the fromExternalChange flag must be set on the returned node state.

Returns:

a copy of this node state with the given root revision and external change flag.

fromExternalChange

@NotNull
public @NotNull DocumentNodeState fromExternalChange()

Returns:

a copy of this DocumentNodeState with the fromExternalChange flag set to true.

isFromExternalChange

public boolean isFromExternalChange()

Specified by:

isFromExternalChange in class AbstractDocumentNodeState

Returns:

true if this node state was created as a result of an external change; false otherwise.

getRootRevision

@NotNull
public @NotNull RevisionVector getRootRevision()

Returns the root revision for this node state. This is the root revision passed from the parent node state. This revision therefore reflects the revision of the root node state where the traversal down the tree started.

Specified by:

getRootRevision in class AbstractDocumentNodeState

Returns:

the revision of the root node state.

getPath

public String getPath()

Specified by:

getPath in class AbstractDocumentNodeState

getLastRevision

public RevisionVector getLastRevision()

Specified by:

getLastRevision in class AbstractDocumentNodeState

exists

public boolean exists()

Description copied from interface: NodeState

Checks whether this node exists. See the above discussion about the existence of node states.

Specified by:

exists in interface NodeState

Returns:

true if this node exists, false if not

getProperty

public PropertyState getProperty(@NotNull
                                 @NotNull String name)

Description copied from interface: NodeState

Returns the named property, or null if no such property exists.

Specified by:

getProperty in interface NodeState

Overrides:

getProperty in class AbstractNodeState

Parameters:

name - name of the property to return

Returns:

named property, or null if not found

hasProperty

public boolean hasProperty(@NotNull
                           @NotNull String name)

Description copied from interface: NodeState

Checks whether the named property exists. The implementation is equivalent to getProperty(name) != null, but may be optimized to avoid having to load the property value.

Specified by:

hasProperty in interface NodeState

Overrides:

hasProperty in class AbstractNodeState

Parameters:

name - property name

Returns:

true if the named property exists, false otherwise

getProperties

@NotNull
public @NotNull Iterable<? extends PropertyState> getProperties()

Description copied from interface: NodeState

Returns an iterable of the properties of this node. Multiple iterations are guaranteed to return the properties in the same order, but the specific order used is implementation-dependent and may change across different states of the same node.

Specified by:

getProperties in interface NodeState

Returns:

properties in some stable order

hasChildNode

public boolean hasChildNode(@NotNull
                            @NotNull String name)

Description copied from interface: NodeState

Checks whether the named child node exists. The implementation is equivalent to getChildNode(name).exists(), except that passing an invalid name as argument will result in a false return value instead of an IllegalArgumentException.

Specified by:

hasChildNode in interface NodeState

Parameters:

name - name of the child node

Returns:

true if the named child node exists, false otherwise

getChildNode

@NotNull
public @NotNull NodeState getChildNode(@NotNull
                                                @NotNull String name)

Description copied from interface: NodeState

Returns the named, possibly non-existent, child node. Use the NodeState.exists() method on the returned child node to determine whether the node exists or not.

Specified by:

getChildNode in interface NodeState

Parameters:

name - name of the child node to return

Returns:

named child node

getChildNodeCount

public long getChildNodeCount(long max)

Description copied from interface: NodeState

Returns the number of iterable child nodes of this node.

If an implementation knows the exact value, it returns it (even if the value is higher than max). If the implementation does not know the exact value, and the child node count is higher than max, it may return Long.MAX_VALUE. The cost of the operation is at most O(max).

Specified by:

getChildNodeCount in interface NodeState

Overrides:

getChildNodeCount in class AbstractNodeState

Parameters:

max - the maximum number of entries to traverse

Returns:

number of iterable child nodes

getPropertyCount

public long getPropertyCount()

Description copied from interface: NodeState

Returns the number of properties of this node.

Specified by:

getPropertyCount in interface NodeState

Overrides:

getPropertyCount in class AbstractNodeState

Returns:

number of properties

getChildNodeEntries

@NotNull
public @NotNull Iterable<? extends ChildNodeEntry> getChildNodeEntries()

Description copied from interface: NodeState

Returns the iterable child node entries of this instance. Multiple iterations are guaranteed to return the child nodes in the same order, but the specific order used is implementation dependent and may change across different states of the same node.

Note on cost and performance: while it is possible to iterate over all child NodeStates with the two methods NodeState.getChildNodeNames() and NodeState.getChildNode(String), this method is considered more efficient because an implementation can potentially perform the retrieval of the name and NodeState in one call. This results in O(n) vs. O(n log n) when iterating over the child node names and then look up the NodeState by name.

Specified by:

getChildNodeEntries in interface NodeState

Returns:

child node entries in some stable order

builder

@NotNull
public @NotNull NodeBuilder builder()

Description copied from interface: NodeState

Returns a builder for constructing a new node state based on this state, i.e. starting with all the properties and child nodes of this state.

Specified by:

builder in interface NodeState

Returns:

node builder based on this state

getBundledChildNodeNames

public Set<String> getBundledChildNodeNames()

hasOnlyBundledChildren

public boolean hasOnlyBundledChildren()

hasNoChildren

public boolean hasNoChildren()

Specified by:

hasNoChildren in class AbstractDocumentNodeState

getNodeStateDiffer

protected NodeStateDiffer getNodeStateDiffer()

Specified by:

getNodeStateDiffer in class AbstractDocumentNodeState

toString

public String toString()

Description copied from class: AbstractNodeState

Returns a string representation of this node state.

Overrides:

toString in class AbstractNodeState

Returns:

string representation

getMemory

public int getMemory()

Description copied from interface: CacheValue

The estimated amount of memory used by this object, in bytes.

Specified by:

getMemory in interface CacheValue

Returns:

the estimated number of bytes

getAllBundledNodesStates

public Iterable<DocumentNodeState> getAllBundledNodesStates()

asString

public String asString()

fromString

public static DocumentNodeState fromString(DocumentNodeStore store,
                                           String s)