|
ModeShape Distribution 3.2.0.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.modeshape.jcr.cache.document.AbstractChildReferences
public abstract class AbstractChildReferences
An partial ChildReferences
implementation that can serve as a base class to provide default implementations of some
methods to simplify other implementations.
Nested Class Summary | |
---|---|
protected static class |
AbstractChildReferences.ChildReferenceWithNameIterator
|
Nested classes/interfaces inherited from interface org.modeshape.jcr.cache.ChildReferences |
---|
ChildReferences.BasicContext, ChildReferences.Changes, ChildReferences.ChildInsertions, ChildReferences.Context, ChildReferences.NoChanges, ChildReferences.NoContext, ChildReferences.NoSnsIndexesContext, ChildReferences.SingleNameContext, ChildReferences.WithChanges |
Field Summary |
---|
Fields inherited from interface org.modeshape.jcr.cache.ChildReferences |
---|
UNKNOWN_SIZE |
Constructor Summary | |
---|---|
AbstractChildReferences()
|
Method Summary | |
---|---|
protected Iterator<ChildReference> |
contextSensitiveIterator(Iterator<ChildReference> original,
ChildReferences.Context context)
|
ChildReference |
getChild(Name name)
Look for the child reference that has the given name and a SNS index of '1'. |
ChildReference |
getChild(Name name,
int snsIndex)
Look for the child reference that has the given name and SNS index. |
ChildReference |
getChild(Path.Segment segment)
Look for the child reference that has the given name and SNS index. |
boolean |
isEmpty()
Determine if there are no references in this container. |
Iterator<ChildReference> |
iterator(ChildReferences.Context context)
Get an iterator over all child references in this collection, but base the SNS indexes upon those already consumed. |
Iterator<ChildReference> |
iterator(ChildReferences.Context context,
Collection<?> namePatterns,
NamespaceRegistry registry)
Get an iterator over all of the children that have names matching at least one of the supplied patterns, using the supplied context. |
Iterator<ChildReference> |
iterator(ChildReferences.Context context,
Name name)
|
Iterator<ChildReference> |
iterator(Collection<?> namePatterns,
NamespaceRegistry registry)
Get an iterator over all of the children that have names matching at least one of the supplied patterns. |
Iterator<ChildReference> |
iterator(Name name)
Get an iterator over all of the children that have same name matching the supplied value. |
Iterator<ChildReference> |
iterator(Name name,
ChildReferences.Context context)
Get an iterator over all of the children that have same name matching the supplied value. |
boolean |
supportsGetChildReferenceByKey()
Return whether it is possible/feasible to find a ChildReference for a child node given
only its NodeKey. |
String |
toString()
|
abstract StringBuilder |
toString(StringBuilder sb)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.modeshape.jcr.cache.ChildReferences |
---|
getAllKeys, getChild, getChild, getChild, getChildCount, hasChild, iterator, size |
Constructor Detail |
---|
public AbstractChildReferences()
Method Detail |
---|
public boolean supportsGetChildReferenceByKey()
ChildReferences
find
a ChildReference for a child node given
only its NodeKey. Implementations that have very large numbers of children may provide an alternative way to
lookup
a child reference directly. In such cases, this method may
return false.
supportsGetChildReferenceByKey
in interface ChildReferences
ChildReferences.getChild(NodeKey)
and ChildReferences.getChild(NodeKey, Context)
should be used to find the
ChildReference, or false if doing so is not recommended.public boolean isEmpty()
ChildReferences
size() == 0
but may be
faster.
isEmpty
in interface ChildReferences
public ChildReference getChild(Name name)
ChildReferences
getChild
in interface ChildReferences
name
- the name for the node
public ChildReference getChild(Path.Segment segment)
ChildReferences
getChild
in interface ChildReferences
segment
- the path segment, which defines the name and SNS index
public ChildReference getChild(Name name, int snsIndex)
ChildReferences
getChild
in interface ChildReferences
name
- the name for the nodesnsIndex
- the same-name-sibling index; must be positive
public Iterator<ChildReference> iterator(Name name)
ChildReferences
iterator
in interface ChildReferences
name
- the name of the same-name-sibling nodes; may not be null
public Iterator<ChildReference> iterator(Name name, ChildReferences.Context context)
ChildReferences
iterator
in interface ChildReferences
name
- the name of the same-name-sibling nodes; may not be nullcontext
- the context in which the child should be evaluated; may be null if there is no context
public Iterator<ChildReference> iterator(ChildReferences.Context context)
iterator
in interface ChildReferences
context
- the context in which the child should be evaluated; may be null if there is no context
protected Iterator<ChildReference> contextSensitiveIterator(Iterator<ChildReference> original, ChildReferences.Context context)
public Iterator<ChildReference> iterator(Collection<?> namePatterns, NamespaceRegistry registry)
ChildReferences
iterator
in interface ChildReferences
namePatterns
- the list of string literals or regex patterns describing the namesregistry
- the namespace registry, used to convert names to a form compatible with the name patterns
public Iterator<ChildReference> iterator(ChildReferences.Context context, Collection<?> namePatterns, NamespaceRegistry registry)
ChildReferences
iterator
in interface ChildReferences
context
- the context in which the child should be evaluated; may be null if there is no contextnamePatterns
- the list of string literals or regex patterns describing the namesregistry
- the namespace registry, used to convert names to a form compatible with the name patterns
public Iterator<ChildReference> iterator(ChildReferences.Context context, Name name)
public String toString()
toString
in class Object
public abstract StringBuilder toString(StringBuilder sb)
|
ModeShape Distribution 3.2.0.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |