Class AbstractNodeState
java.lang.Object
org.apache.jackrabbit.oak.spi.state.AbstractNodeState
- All Implemented Interfaces:
NodeState
- Direct Known Subclasses:
AbstractDecoratedNodeState
,AbstractDocumentNodeState
,ModifiedNodeState
Abstract base class for
NodeState
implementations.
This base class contains default implementations of the
equals(Object)
and hashCode()
methods based on
the implemented interface.
This class also implements trivial (and potentially very slow) versions of
the getProperty(String)
and getPropertyCount()
methods
based on NodeState.getProperties()
. The getChildNodeCount(long)
method
is similarly implemented based on NodeState.getChildNodeEntries()
.
Subclasses should normally override these method with a more efficient
alternatives.
-
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic void
checkValidName
(String name) boolean
compareAgainstBaseState
(NodeState base, NodeStateDiff diff) Generic default comparison algorithm that simply walks through the property and child node lists of the given base state and compares the entries one by one with corresponding ones (if any) in this state.static boolean
compareAgainstBaseState
(NodeState state, NodeState base, NodeStateDiff diff) Generic default comparison algorithm that simply walks through the property and child node lists of the given base state and compares the entries one by one with corresponding ones (if any) in this state.static boolean
comparePropertiesAgainstBaseState
(NodeState state, NodeState base, NodeStateDiff diff) Compares the properties ofbase
state withthis
state.protected static long
boolean
Checks whether the given object is equal to this one.static boolean
boolean
getBoolean
(@NotNull String name) Returns the boolean value of the named property.static boolean
getBoolean
(NodeState state, String name) long
getChildNodeCount
(long max) Returns the number of iterable child nodes of this node.Returns the names of all iterable child nodes.long
Returns the long value of the named property.static long
@Nullable String
Returns the name value of the named property.static String
Returns the name values of the named property.getProperty
(@NotNull String name) Returns the named property, ornull
if no such property exists.long
Returns the number of properties of this node.Returns the string value of the named property.static String
getStrings
(@NotNull String name) Returns the string values of the named property.getStrings
(NodeState state, String name) int
hashCode()
Returns a hash code that's compatible with how theequals(Object)
method is implemented.boolean
hasProperty
(@NotNull String name) Checks whether the named property exists.static boolean
isValidName
(String name) toString()
Returns a string representation of this node state.static String
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.apache.jackrabbit.oak.spi.state.NodeState
builder, exists, getChildNode, getChildNodeEntries, getProperties, hasChildNode
-
Constructor Details
-
AbstractNodeState
public AbstractNodeState()
-
-
Method Details
-
isValidName
-
checkValidName
- Throws:
IllegalArgumentException
-
getBoolean
-
getLong
-
getString
-
getStrings
-
getName
-
getNames
-
compareAgainstBaseState
Generic default comparison algorithm that simply walks through the property and child node lists of the given base state and compares the entries one by one with corresponding ones (if any) in this state. -
comparePropertiesAgainstBaseState
public static boolean comparePropertiesAgainstBaseState(NodeState state, NodeState base, NodeStateDiff diff) Compares the properties ofbase
state withthis
state.- Parameters:
state
- the head node state.base
- the base node state.diff
- the node state diff.- Returns:
true
to continue the comparison,false
to stop
-
toString
-
hasProperty
Description copied from interface:NodeState
Checks whether the named property exists. The implementation is equivalent togetProperty(name) != null
, but may be optimized to avoid having to load the property value.- Specified by:
hasProperty
in interfaceNodeState
- Parameters:
name
- property name- Returns:
true
if the named property exists,false
otherwise
-
getBoolean
Description copied from interface:NodeState
Returns the boolean value of the named property. The implementation is equivalent to the following code, but may be optimized.PropertyState property = state.getProperty(name); return property != null && property.getType() == Type.BOOLEAN && property.getValue(Type.BOOLEAN);
- Specified by:
getBoolean
in interfaceNodeState
- Parameters:
name
- property name- Returns:
- boolean value of the named property, or
false
-
getLong
Description copied from interface:NodeState
Returns the long value of the named property. The implementation is equivalent to the following code, but may be optimized.PropertyState property = state.getProperty(name); if (property != null && property.getType() == Type.LONG) { return property.getValue(Type.LONG); } else { return 0; }
-
getString
Description copied from interface:NodeState
Returns the string value of the named property. The implementation is equivalent to the following code, but may be optimized.PropertyState property = state.getProperty(name); if (property != null && property.getType() == Type.STRING) { return property.getValue(Type.STRING); } else { return null; }
-
getStrings
Description copied from interface:NodeState
Returns the string values of the named property. The implementation is equivalent to the following code, but may be optimized.PropertyState property = state.getProperty(name); if (property != null && property.getType() == Type.STRINGS) { return property.getValue(Type.STRINGS); } else { return Collections.emptyList(); }
- Specified by:
getStrings
in interfaceNodeState
- Parameters:
name
- property name- Returns:
- string values of the named property, or an empty collection
-
getName
Description copied from interface:NodeState
Returns the name value of the named property. The implementation is equivalent to the following code, but may be optimized.PropertyState property = state.getProperty(name); if (property != null && property.getType() == Type.NAME) { return property.getValue(Type.NAME); } else { return null; }
-
getNames
Description copied from interface:NodeState
Returns the name values of the named property. The implementation is equivalent to the following code, but may be optimized.PropertyState property = state.getProperty(name); if (property != null && property.getType() == Type.NAMES) { return property.getValue(Type.NAMES); } else { return Collections.emptyList(); }
-
getProperty
Description copied from interface:NodeState
Returns the named property, ornull
if no such property exists.- Specified by:
getProperty
in interfaceNodeState
- Parameters:
name
- name of the property to return- Returns:
- named property, or
null
if not found
-
getPropertyCount
public long getPropertyCount()Description copied from interface:NodeState
Returns the number of properties of this node.- Specified by:
getPropertyCount
in interfaceNodeState
- Returns:
- number of properties
-
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 interfaceNodeState
- Parameters:
max
- the maximum number of entries to traverse- Returns:
- number of iterable child nodes
-
getChildNodeNames
Description copied from interface:NodeState
Returns the names of all iterable child nodes.- Specified by:
getChildNodeNames
in interfaceNodeState
- Returns:
- child node names in some stable order
-
compareAgainstBaseState
Generic default comparison algorithm that simply walks through the property and child node lists of the given base state and compares the entries one by one with corresponding ones (if any) in this state.- Specified by:
compareAgainstBaseState
in interfaceNodeState
- Parameters:
base
- base statediff
- handler of node state differences- Returns:
true
if the full diff was performed, orfalse
if it was aborted as requested by the handler (see theNodeStateDiff
contract for more details)
-
toString
Returns a string representation of this node state. -
equals
Checks whether the given object is equal to this one. Two node states are considered equal if all their properties and child nodes match, regardless of ordering. Subclasses may override this method with a more efficient equality check if one is available. -
equals
-
hashCode
public int hashCode()Returns a hash code that's compatible with how theequals(Object)
method is implemented. The current implementation simply returns zero for everything sinceNodeState
instances are not intended for use as hash keys. -
count
-