Class ContainerPointer
java.lang.Object
org.apache.commons.jxpath.ri.model.NodePointer
org.apache.commons.jxpath.ri.model.container.ContainerPointer
- All Implemented Interfaces:
Serializable
,Cloneable
,Comparable
,Pointer
Transparent pointer to a Container. The
NodePointer.getValue()
method returns the contents of the container, rather than the container itself.- See Also:
-
Field Summary
Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION
-
Constructor Summary
ConstructorsConstructorDescriptionContainerPointer
(Container container, Locale locale) Constructs a new ContainerPointer.ContainerPointer
(NodePointer parent, Container container) Constructs a new ContainerPointer. -
Method Summary
Modifier and TypeMethodDescriptionasPath()
Returns an XPath that maps to this Pointer.attributeIterator
(QName qName) Returns a NodeIterator that iterates over all attributes of the current node matching the supplied node name (could have a wildcard).childIterator
(NodeTest test, boolean reverse, NodePointer startWith) Returns a NodeIterator that iterates over all children or all children that match the given NodeTest, starting with the specified one.int
compareChildNodePointers
(NodePointer pointer1, NodePointer pointer2) Compares two child NodePointers and returns a positive number, zero or a positive number according to the order of the pointers.boolean
Gets the value represented by the pointer before indexing.Returns the object the pointer points to; does not convert it to a "canonical" type.Gets this instance by default, subclasses can return a pointer for the immediately contained value.int
If the pointer represents a collection (or collection element), returns the length of the collection.getName()
Gets the name of this node.getNamespaceURI
(String prefix) Decodes a namespace prefix to the corresponding URI.int
hashCode()
boolean
Returnstrue
if the value of the pointer is an array or a Collection.boolean
This type of node is auxiliary.boolean
isLeaf()
If true, this node does not have childrenReturns a NodeIterator that iterates over all namespaces of the value currently pointed at.namespacePointer
(String namespace) Returns a NodePointer for the specified namespace.void
Converts the value to the required type and changes the corresponding object to that value.boolean
Checks if this Pointer matches the supplied NodeTest.Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer
clone, compareTo, createAttribute, createChild, createChild, createPath, createPath, escape, getAbstractFactory, getDefaultNamespaceURI, getImmediateParentPointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNode, getNodeSetByKey, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValue, getValuePointer, handle, handle, isActual, isAttribute, isDefaultNamespace, isLanguage, isNode, isRoot, newChildNodePointer, newNodePointer, printPointerChain, remove, setAttribute, setExceptionHandler, setIndex, setNamespaceResolver, toString, verify
-
Constructor Details
-
ContainerPointer
Constructs a new ContainerPointer.- Parameters:
container
- Container objectlocale
- Locale
-
ContainerPointer
Constructs a new ContainerPointer.- Parameters:
parent
- parent pointercontainer
- Container object
-
-
Method Details
-
asPath
Description copied from class:NodePointer
Returns an XPath that maps to this Pointer.- Specified by:
asPath
in interfacePointer
- Overrides:
asPath
in classNodePointer
- Returns:
- String XPath expression
-
attributeIterator
Description copied from class:NodePointer
Returns a NodeIterator that iterates over all attributes of the current node matching the supplied node name (could have a wildcard). May return null if the object does not support the attributes.- Overrides:
attributeIterator
in classNodePointer
- Parameters:
qName
- the attribute name to test- Returns:
- NodeIterator
-
childIterator
Description copied from class:NodePointer
Returns a NodeIterator that iterates over all children or all children that match the given NodeTest, starting with the specified one.- Overrides:
childIterator
in classNodePointer
- Parameters:
test
- NodeTest to filter childrenreverse
- specified iteration directionstartWith
- the NodePointer to start with- Returns:
- NodeIterator
-
compareChildNodePointers
Description copied from class:NodePointer
Compares two child NodePointers and returns a positive number, zero or a positive number according to the order of the pointers.- Specified by:
compareChildNodePointers
in classNodePointer
- Parameters:
pointer1
- first pointer to be comparedpointer2
- second pointer to be compared- Returns:
- int per Java comparison conventions
-
equals
-
getBaseValue
Description copied from class:NodePointer
Gets the value represented by the pointer before indexing. So, if the node represents an element of a collection, this method returns the collection itself.- Specified by:
getBaseValue
in classNodePointer
- Returns:
- Object value
-
getImmediateNode
Description copied from class:NodePointer
Returns the object the pointer points to; does not convert it to a "canonical" type.- Specified by:
getImmediateNode
in classNodePointer
- Returns:
- Object node
-
getImmediateValuePointer
Description copied from class:NodePointer
Gets this instance by default, subclasses can return a pointer for the immediately contained value.- Overrides:
getImmediateValuePointer
in classNodePointer
- Returns:
- NodePointer is either
this
or a pointer for the immediately contained value. - See Also:
-
getLength
Description copied from class:NodePointer
If the pointer represents a collection (or collection element), returns the length of the collection. Otherwise returns 1 (even if the value is null).- Specified by:
getLength
in classNodePointer
- Returns:
- the length.
-
getName
Description copied from class:NodePointer
Gets the name of this node. Can be null.- Specified by:
getName
in classNodePointer
- Returns:
- QName The name of this node. Can be null.
-
getNamespaceURI
Description copied from class:NodePointer
Decodes a namespace prefix to the corresponding URI.- Overrides:
getNamespaceURI
in classNodePointer
- Parameters:
prefix
- prefix to decode- Returns:
- String uri
-
hashCode
-
isCollection
Description copied from class:NodePointer
Returnstrue
if the value of the pointer is an array or a Collection.- Specified by:
isCollection
in classNodePointer
- Returns:
- boolean
-
isContainer
This type of node is auxiliary.- Overrides:
isContainer
in classNodePointer
- Returns:
true
.
-
isLeaf
Description copied from class:NodePointer
If true, this node does not have children- Specified by:
isLeaf
in classNodePointer
- Returns:
- boolean
-
namespaceIterator
Description copied from class:NodePointer
Returns a NodeIterator that iterates over all namespaces of the value currently pointed at. May return null if the object does not support the namespaces.- Overrides:
namespaceIterator
in classNodePointer
- Returns:
- NodeIterator
-
namespacePointer
Description copied from class:NodePointer
Returns a NodePointer for the specified namespace. Will return null if namespaces are not supported. Will return UNKNOWN_NAMESPACE if there is no such namespace.- Overrides:
namespacePointer
in classNodePointer
- Parameters:
namespace
- incoming namespace- Returns:
- NodePointer for
namespace
-
setValue
Description copied from class:NodePointer
Converts the value to the required type and changes the corresponding object to that value.- Specified by:
setValue
in interfacePointer
- Specified by:
setValue
in classNodePointer
- Parameters:
value
- the value to set
-
testNode
Description copied from class:NodePointer
Checks if this Pointer matches the supplied NodeTest.- Overrides:
testNode
in classNodePointer
- Parameters:
nodeTest
- the NodeTest to execute- Returns:
- true if a match
-