Package org.apache.jackrabbit.oak.plugins.document.secondary

Class DelegatingDocumentNodeState

java.lang.Object

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

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

org.apache.jackrabbit.oak.plugins.document.secondary.DelegatingDocumentNodeState

All Implemented Interfaces:

org.apache.jackrabbit.oak.spi.state.NodeState

public class DelegatingDocumentNodeState
extends AbstractDocumentNodeState

NodeState wrapper which wraps another NodeState (mostly SegmentNodeState) so as to expose it as an AbstractDocumentNodeState by extracting the meta properties which are stored as hidden properties

Field Summary

Fields

Modifier and Type	Field	Description
static String	PROP_LAST_REV
static String	PROP_REVISION

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

EXISTS

Method Summary

Modifier and Type	Method	Description
@NotNull org.apache.jackrabbit.oak.spi.state.NodeBuilder	builder()
boolean	exists()
boolean	getBoolean(@NotNull String name)
@NotNull org.apache.jackrabbit.oak.spi.state.NodeState	getChildNode(@NotNull String name)
long	getChildNodeCount(long max)
@NotNull Iterable<? extends org.apache.jackrabbit.oak.spi.state.ChildNodeEntry>	getChildNodeEntries()
Iterable<String>	getChildNodeNames()
RevisionVector	getLastRevision()
long	getLong(String name)
String	getName(@NotNull String name)
@NotNull Iterable<String>	getNames(@NotNull String name)
protected NodeStateDiffer	getNodeStateDiffer()
Path	getPath()
@NotNull Iterable<? extends org.apache.jackrabbit.oak.api.PropertyState>	getProperties()
org.apache.jackrabbit.oak.api.PropertyState	getProperty(@NotNull String name)
long	getPropertyCount()
RevisionVector	getRootRevision()
String	getString(String name)
@NotNull Iterable<String>	getStrings(@NotNull String name)
boolean	hasChildNode(@NotNull String name)
static boolean	hasMetaProps(org.apache.jackrabbit.oak.spi.state.NodeState delegate)
boolean	hasNoChildren()
boolean	hasProperty(@NotNull String name)
boolean	isFromExternalChange()
AbstractDocumentNodeState	withRootRevision(@NotNull RevisionVector root, boolean externalChange)	Creates a copy of this DocumentNodeState with the AbstractDocumentNodeState.getRootRevision() set to the given root revision.
static AbstractDocumentNodeState	wrap(org.apache.jackrabbit.oak.spi.state.NodeState delegate, NodeStateDiffer differ)
static org.apache.jackrabbit.oak.spi.state.NodeState	wrapIfPossible(org.apache.jackrabbit.oak.spi.state.NodeState delegate, NodeStateDiffer differ)	Wraps a given root NodeState as a DelegatingDocumentNodeState if it has required meta properties otherwise just returns the passed NodeState

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, getLong, getName, getNames, getString, getStrings, hashCode, isValidName, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

PROP_REVISION

public static final String PROP_REVISION

See Also:

Constant Field Values

PROP_LAST_REV

public static final String PROP_LAST_REV

See Also:

Constant Field Values

Method Detail

wrapIfPossible

public static org.apache.jackrabbit.oak.spi.state.NodeState wrapIfPossible(org.apache.jackrabbit.oak.spi.state.NodeState delegate,
                                                                           NodeStateDiffer differ)

Wraps a given root NodeState as a DelegatingDocumentNodeState if it has required meta properties otherwise just returns the passed NodeState

Parameters:

delegate - nodeState to wrap

Returns:

wrapped state or original state

hasMetaProps

public static boolean hasMetaProps(org.apache.jackrabbit.oak.spi.state.NodeState delegate)

wrap

public static AbstractDocumentNodeState wrap(org.apache.jackrabbit.oak.spi.state.NodeState delegate,
                                             NodeStateDiffer differ)

getPath

public Path getPath()

Specified by:

getPath in class AbstractDocumentNodeState

getLastRevision

public RevisionVector getLastRevision()

Specified by:

getLastRevision in class AbstractDocumentNodeState

getRootRevision

public RevisionVector getRootRevision()

Specified by:

getRootRevision in class AbstractDocumentNodeState

isFromExternalChange

public boolean isFromExternalChange()

Specified by:

isFromExternalChange in class AbstractDocumentNodeState

withRootRevision

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

Description copied from class: AbstractDocumentNodeState

Creates a copy of this DocumentNodeState with the AbstractDocumentNodeState.getRootRevision() 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 AbstractDocumentNodeState.isFromExternalChange() flags are equal.

Specified by:

withRootRevision in class AbstractDocumentNodeState

Parameters:

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

externalChange - if the AbstractDocumentNodeState.isFromExternalChange() 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.

hasNoChildren

public boolean hasNoChildren()

Specified by:

hasNoChildren in class AbstractDocumentNodeState

getNodeStateDiffer

protected NodeStateDiffer getNodeStateDiffer()

Specified by:

getNodeStateDiffer in class AbstractDocumentNodeState

exists

public boolean exists()

getProperties

@NotNull
public @NotNull Iterable<? extends org.apache.jackrabbit.oak.api.PropertyState> getProperties()

hasChildNode

public boolean hasChildNode(@NotNull
                            @NotNull String name)

getChildNode

@NotNull
public @NotNull org.apache.jackrabbit.oak.spi.state.NodeState getChildNode(@NotNull
                                                                           @NotNull String name)
                                                                    throws IllegalArgumentException

Throws:

IllegalArgumentException

getChildNodeEntries

@NotNull
public @NotNull Iterable<? extends org.apache.jackrabbit.oak.spi.state.ChildNodeEntry> getChildNodeEntries()

builder

@NotNull
public @NotNull org.apache.jackrabbit.oak.spi.state.NodeBuilder builder()

getProperty

public org.apache.jackrabbit.oak.api.PropertyState getProperty(@NotNull
                                                               @NotNull String name)

Specified by:

getProperty in interface org.apache.jackrabbit.oak.spi.state.NodeState

Overrides:

getProperty in class org.apache.jackrabbit.oak.spi.state.AbstractNodeState

getPropertyCount

public long getPropertyCount()

Specified by:

getPropertyCount in interface org.apache.jackrabbit.oak.spi.state.NodeState

Overrides:

getPropertyCount in class org.apache.jackrabbit.oak.spi.state.AbstractNodeState

hasProperty

public boolean hasProperty(@NotNull
                           @NotNull String name)

Specified by:

hasProperty in interface org.apache.jackrabbit.oak.spi.state.NodeState

Overrides:

hasProperty in class org.apache.jackrabbit.oak.spi.state.AbstractNodeState

getBoolean

public boolean getBoolean(@NotNull
                          @NotNull String name)

Specified by:

getBoolean in interface org.apache.jackrabbit.oak.spi.state.NodeState

Overrides:

getBoolean in class org.apache.jackrabbit.oak.spi.state.AbstractNodeState

getLong

public long getLong(String name)

Specified by:

getLong in interface org.apache.jackrabbit.oak.spi.state.NodeState

Overrides:

getLong in class org.apache.jackrabbit.oak.spi.state.AbstractNodeState

getString

public String getString(String name)

Specified by:

getString in interface org.apache.jackrabbit.oak.spi.state.NodeState

Overrides:

getString in class org.apache.jackrabbit.oak.spi.state.AbstractNodeState

getStrings

@NotNull
public @NotNull Iterable<String> getStrings(@NotNull
                                            @NotNull String name)

Specified by:

getStrings in interface org.apache.jackrabbit.oak.spi.state.NodeState

Overrides:

getStrings in class org.apache.jackrabbit.oak.spi.state.AbstractNodeState

getName

public String getName(@NotNull
                      @NotNull String name)

Specified by:

getName in interface org.apache.jackrabbit.oak.spi.state.NodeState

Overrides:

getName in class org.apache.jackrabbit.oak.spi.state.AbstractNodeState

getNames

@NotNull
public @NotNull Iterable<String> getNames(@NotNull
                                          @NotNull String name)

Specified by:

getNames in interface org.apache.jackrabbit.oak.spi.state.NodeState

Overrides:

getNames in class org.apache.jackrabbit.oak.spi.state.AbstractNodeState

getChildNodeCount

public long getChildNodeCount(long max)

Specified by:

getChildNodeCount in interface org.apache.jackrabbit.oak.spi.state.NodeState

Overrides:

getChildNodeCount in class org.apache.jackrabbit.oak.spi.state.AbstractNodeState

getChildNodeNames

public Iterable<String> getChildNodeNames()

Specified by:

getChildNodeNames in interface org.apache.jackrabbit.oak.spi.state.NodeState

Overrides:

getChildNodeNames in class org.apache.jackrabbit.oak.spi.state.AbstractNodeState