Class NullPropertyPointer
java.lang.Object
org.apache.commons.jxpath.ri.model.NodePointer
org.apache.commons.jxpath.ri.model.beans.PropertyPointer
org.apache.commons.jxpath.ri.model.beans.NullPropertyPointer
- All Implemented Interfaces:
Serializable,Cloneable,Comparable,Pointer
Pointer to a null property.
- See Also:
-
Field Summary
Fields inherited from class org.apache.commons.jxpath.ri.model.beans.PropertyPointer
bean, propertyIndex, UNSPECIFIED_PROPERTYFields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION -
Constructor Summary
ConstructorsConstructorDescriptionNullPropertyPointer(NodePointer parent) Constructs a new NullPropertyPointer. -
Method Summary
Modifier and TypeMethodDescriptionasPath()Returns an XPath that maps to this Pointer.createChild(JXPathContext context, QName qName, int index) Called by a child pointer when it needs to create a parent object for a non-existent collection element.createChild(JXPathContext context, QName qName, int index, Object value) Called by a child pointer if that child needs to assign the value supplied in the createPath(context, value) call to a non-existent node.createPath(JXPathContext context) Called by a child pointer when it needs to create a parent object.createPath(JXPathContext context, Object value) Called directly by JXPathContext.Gets 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 property contains a collection, then the length of that collection, otherwise - 1.getName()Gets the name of this node.intCount the number of properties represented.Gets the property name.String[]Gets the names of the included properties.If this pointer manages a transparent container, like a variable, this method returns the pointer to the contents.booleanisActual()An actual pointer points to an existing part of an object graph, even if it is null.protected booleanTests whether this pointer references an actual property.booleanReturnstrueif the value of the pointer is an array or a Collection.booleanIf true, this node is auxiliary and can only be used as an intermediate in the chain of pointers.booleanisLeaf()If true, this node does not have childrenvoidsetNameAttributeValue(String attributeValue) Sets the name attribute.voidsetPropertyIndex(int index) Sets the property index.voidsetPropertyName(String propertyName) Sets the property name.voidConverts the value to the required type and changes the corresponding object to that value.Methods inherited from class org.apache.commons.jxpath.ri.model.beans.PropertyPointer
compareChildNodePointers, equals, getBean, getImmediateValuePointer, getPropertyIndex, hashCodeMethods inherited from class org.apache.commons.jxpath.ri.model.NodePointer
attributeIterator, childIterator, clone, compareTo, createAttribute, escape, getAbstractFactory, getDefaultNamespaceURI, getImmediateParentPointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNamespaceURI, getNode, getNodeSetByKey, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValue, handle, handle, isAttribute, isDefaultNamespace, isLanguage, isNode, isRoot, namespaceIterator, namespacePointer, newChildNodePointer, newNodePointer, printPointerChain, remove, setAttribute, setExceptionHandler, setIndex, setNamespaceResolver, testNode, toString, verify
-
Constructor Details
-
NullPropertyPointer
Constructs a new NullPropertyPointer.- Parameters:
parent- pointer
-
-
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
-
createChild
Description copied from class:NodePointerCalled by a child pointer when it needs to create a parent object for a non-existent collection element. It may have to expand the collection, then create an element object and return a new pointer describing the newly created element.- Overrides:
createChildin classPropertyPointer- Parameters:
context- the owning JXPathCOntextqName- the QName at which a child should be createdindex- child index.- Returns:
- created NodePointer
-
createChild
Description copied from class:NodePointerCalled by a child pointer if that child needs to assign the value supplied in the createPath(context, value) call to a non-existent node. This method may have to expand the collection in order to assign the element.- Overrides:
createChildin classPropertyPointer- Parameters:
context- the owning JXPathCOntextqName- the QName at which a child should be createdindex- child index.value- node value to set- Returns:
- created NodePointer
-
createPath
Description copied from class:NodePointerCalled by a child pointer when it needs to create a parent object. Must create an object described by this pointer and return a new pointer that properly describes the new object.- Overrides:
createPathin classPropertyPointer- Parameters:
context- the owning JXPathContext- Returns:
- created NodePointer
-
createPath
Description copied from class:NodePointerCalled directly by JXPathContext. Must create path and set value.- Overrides:
createPathin classPropertyPointer- Parameters:
context- the owning JXPathContextvalue- the new value to set- Returns:
- created NodePointer
-
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.- Overrides:
getImmediateNodein classPropertyPointer- Returns:
- Object node
-
getLength
Description copied from class:PropertyPointerIf the property contains a collection, then the length of that collection, otherwise - 1.- Overrides:
getLengthin classPropertyPointer- Returns:
- int length
-
getName
Description copied from class:NodePointerGets the name of this node. Can be null.- Overrides:
getNamein classPropertyPointer- Returns:
- QName The name of this node. Can be null.
-
getPropertyCount
Description copied from class:PropertyPointerCount the number of properties represented.- Specified by:
getPropertyCountin classPropertyPointer- Returns:
- int
-
getPropertyName
Description copied from class:PropertyPointerGets the property name.- Specified by:
getPropertyNamein classPropertyPointer- Returns:
- String property name.
-
getPropertyNames
Description copied from class:PropertyPointerGets the names of the included properties.- Specified by:
getPropertyNamesin classPropertyPointer- Returns:
- String[]
-
getValuePointer
Description copied from class:NodePointerIf this pointer manages a transparent container, like a variable, this method returns the pointer to the contents. Only an auxiliary (non-node) pointer can (and should) return a value pointer other than itself. Note that you probably don't want to overridegetValuePointer()directly. Override thegetImmediateValuePointer()method instead. ThegetValuePointer()method is callsgetImmediateValuePointer()and, if the result is notthis, invokesgetValuePointer()recursively. The idea here is to open all nested containers. Let's say we have a container within a container within a container. ThegetValuePointer()method should then open all those containers and return the pointer to the ultimate contents. It does so with the above recursion.- Overrides:
getValuePointerin classNodePointer- Returns:
- NodePointer
-
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 classPropertyPointer- Returns:
- boolean
-
isActualProperty
Description copied from class:PropertyPointerTests whether this pointer references an actual property.- Specified by:
isActualPropertyin classPropertyPointer- Returns:
- true if actual
-
isCollection
Description copied from class:NodePointerReturnstrueif the value of the pointer is an array or a Collection.- Overrides:
isCollectionin classPropertyPointer- Returns:
- boolean
-
isContainer
Description copied from class:NodePointerIf true, this node is auxiliary and can only be used as an intermediate in the chain of pointers.- Overrides:
isContainerin classNodePointer- Returns:
- boolean
-
isLeaf
Description copied from class:NodePointerIf true, this node does not have children- Overrides:
isLeafin classPropertyPointer- Returns:
- boolean
-
setNameAttributeValue
Sets the name attribute.- Parameters:
attributeValue- value to set
-
setPropertyIndex
Description copied from class:PropertyPointerSets the property index.- Overrides:
setPropertyIndexin classPropertyPointer- Parameters:
index- property index
-
setPropertyName
Description copied from class:PropertyPointerSets the property name.- Specified by:
setPropertyNamein classPropertyPointer- Parameters:
propertyName- property name to set.
-
setValue
Description copied from class:NodePointerConverts the value to the required type and changes the corresponding object to that value.- Specified by:
setValuein interfacePointer- Specified by:
setValuein classNodePointer- Parameters:
value- the value to set
-