Class DOMAttributePointer
java.lang.Object
org.apache.commons.jxpath.ri.model.NodePointer
org.apache.commons.jxpath.ri.model.dom.DOMAttributePointer
- All Implemented Interfaces:
Serializable,Cloneable,Comparable,Pointer
A Pointer that points to a DOM
Attr node. Because the underlying DOM Attr is not Serializable, neither is this pointer class truly so.- See Also:
-
Field Summary
Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION -
Constructor Summary
ConstructorsConstructorDescriptionDOMAttributePointer(NodePointer parent, Attr attr) Constructs a new DOMAttributePointer. -
Method Summary
Modifier and TypeMethodDescriptionasPath()Returns an XPath that maps to this Pointer.intcompareChildNodePointers(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.booleanGets the value represented by the pointer before indexing.Returns the object the pointer points to; does not convert it to a "canonical" type.intIf the pointer represents a collection (or collection element), returns the length of the collection.getName()Gets the name of this node.Returns the namespace URI associated with this Pointer.getValue()By default, returnsgetNode(), can be overridden to return a "canonical" value, like for instance a DOM element should return its string value.inthashCode()booleanisActual()An actual pointer points to an existing part of an object graph, even if it is null.booleanReturnstrueif the value of the pointer is an array or a Collection.booleanisLeaf()If true, this node does not have childrenvoidremove()Remove the node of the object graph this pointer points to.voidSets the value of this attribute.booleanChecks if this Pointer matches the supplied NodeTest.Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer
attributeIterator, childIterator, clone, compareTo, createAttribute, createChild, createChild, createPath, createPath, escape, getAbstractFactory, getDefaultNamespaceURI, getImmediateParentPointer, getImmediateValuePointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNode, getNodeSetByKey, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValuePointer, handle, handle, isAttribute, isContainer, isDefaultNamespace, isLanguage, isNode, isRoot, namespaceIterator, namespacePointer, newChildNodePointer, newNodePointer, printPointerChain, setAttribute, setExceptionHandler, setIndex, setNamespaceResolver, toString, verify
-
Constructor Details
-
DOMAttributePointer
Constructs a new DOMAttributePointer.- Parameters:
parent- pointerattr- pointed
-
-
Method Details
-
asPath
Description copied from class:NodePointerReturns an XPath that maps to this Pointer.- Specified by:
asPathin interfacePointer- Overrides:
asPathin classNodePointer- Returns:
- String XPath expression
-
compareChildNodePointers
Description copied from class:NodePointerCompares two child NodePointers and returns a positive number, zero or a positive number according to the order of the pointers.- Specified by:
compareChildNodePointersin 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:NodePointerGets 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:
getBaseValuein classNodePointer- Returns:
- Object value
-
getImmediateNode
Description copied from class:NodePointerReturns the object the pointer points to; does not convert it to a "canonical" type.- Specified by:
getImmediateNodein classNodePointer- Returns:
- Object node
-
getLength
Description copied from class:NodePointerIf 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:
getLengthin classNodePointer- Returns:
- the length.
-
getName
Description copied from class:NodePointerGets the name of this node. Can be null.- Specified by:
getNamein classNodePointer- Returns:
- QName The name of this node. Can be null.
-
getNamespaceURI
Description copied from class:NodePointerReturns the namespace URI associated with this Pointer.- Overrides:
getNamespaceURIin classNodePointer- Returns:
- String uri
-
getValue
Description copied from class:NodePointerBy default, returnsgetNode(), can be overridden to return a "canonical" value, like for instance a DOM element should return its string value.- Specified by:
getValuein interfacePointer- Overrides:
getValuein classNodePointer- Returns:
- Object value
-
hashCode
-
isActual
Description copied from class:NodePointerAn actual pointer points to an existing part of an object graph, even if it is null. A non-actual pointer represents a part that does not exist at all. For instance consider the pointer "/address/street". If both address and street are not null, the pointer is actual. If address is not null, but street is null, the pointer is still actual. If address is null, the pointer is not actual. (In JavaBeans) if address is not a property of the root bean, a Pointer for this path cannot be obtained at all - actual or otherwise.- Overrides:
isActualin classNodePointer- Returns:
- boolean
-
isCollection
Description copied from class:NodePointerReturnstrueif the value of the pointer is an array or a Collection.- Specified by:
isCollectionin classNodePointer- Returns:
- boolean
-
isLeaf
Description copied from class:NodePointerIf true, this node does not have children- Specified by:
isLeafin classNodePointer- Returns:
- boolean
-
remove
Description copied from class:NodePointerRemove the node of the object graph this pointer points to.- Overrides:
removein classNodePointer
-
setValue
Sets the value of this attribute.- Specified by:
setValuein interfacePointer- Specified by:
setValuein classNodePointer- Parameters:
value- to set
-
testNode
Description copied from class:NodePointerChecks if this Pointer matches the supplied NodeTest.- Overrides:
testNodein classNodePointer- Parameters:
nodeTest- the NodeTest to execute- Returns:
- true if a match
-