Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.commons.jxpath.ri.model.dynamic
Class DynamicPointer  view DynamicPointer download DynamicPointer.java

java.lang.Object
  extended byorg.apache.commons.jxpath.ri.model.NodePointer
      extended byorg.apache.commons.jxpath.ri.model.beans.PropertyOwnerPointer
          extended byorg.apache.commons.jxpath.ri.model.dynamic.DynamicPointer
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable, org.apache.commons.jxpath.Pointer, java.io.Serializable

public class DynamicPointer
extends org.apache.commons.jxpath.ri.model.beans.PropertyOwnerPointer

A Pointer that points to an object with Dynamic Properties. It is used for the first element of a path; following elements will by of type PropertyPointer.

Version:
$Revision: 1.6 $ $Date: 2004/02/29 14:17:44 $

Field Summary
private  java.lang.Object bean
           
private  org.apache.commons.jxpath.DynamicPropertyHandler handler
           
private  org.apache.commons.jxpath.ri.QName name
           
private  java.lang.String[] names
           
 
Fields inherited from class org.apache.commons.jxpath.ri.model.beans.PropertyOwnerPointer
 
Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION
 
Constructor Summary
DynamicPointer(org.apache.commons.jxpath.ri.model.NodePointer parent, org.apache.commons.jxpath.ri.QName name, java.lang.Object bean, org.apache.commons.jxpath.DynamicPropertyHandler handler)
           
DynamicPointer(org.apache.commons.jxpath.ri.QName name, java.lang.Object bean, org.apache.commons.jxpath.DynamicPropertyHandler handler, java.util.Locale locale)
           
 
Method Summary
 java.lang.String asPath()
          Returns an XPath that maps to this Pointer.
 org.apache.commons.jxpath.ri.model.NodeIterator attributeIterator(org.apache.commons.jxpath.ri.QName name)
          Returns a NodeIterator that iterates over all attributes of the current node matching the supplied node name (could have a wildcard).
 org.apache.commons.jxpath.ri.model.NodeIterator createNodeIterator(java.lang.String property, boolean reverse, org.apache.commons.jxpath.ri.model.NodePointer startWith)
           
 boolean equals(java.lang.Object object)
          Determine whether this Object is semantically equal to another Object.
 java.lang.Object getBaseValue()
          Returns the DP object iself.
 int getLength()
          Returns 1.
 org.apache.commons.jxpath.ri.QName getName()
          Returns the name of this node.
 org.apache.commons.jxpath.ri.model.beans.PropertyPointer getPropertyPointer()
           
 int hashCode()
          Get a value that represents this Object, as uniquely as possible within the confines of an int.
 boolean isCollection()
          Returns true if the value of the pointer is an array or a Collection.
 boolean isDynamicPropertyDeclarationSupported()
           
 boolean isLeaf()
          If true, this node does not have children
 
Methods inherited from class org.apache.commons.jxpath.ri.model.beans.PropertyOwnerPointer
childIterator, compareChildNodePointers, getImmediateNode, remove, setIndex, setValue
 
Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer
clone, compareTo, createAttribute, createChild, createChild, createPath, createPath, getDefaultNamespaceURI, getImmediateParentPointer, getImmediateValuePointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNamespaceURI, getNode, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValue, getValuePointer, isActual, isAttribute, isContainer, isDefaultNamespace, isLanguage, isNode, isRoot, namespaceIterator, namespacePointer, newChildNodePointer, newNodePointer, printPointerChain, setAttribute, setNamespaceResolver, testNode, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

name

private org.apache.commons.jxpath.ri.QName name

bean

private java.lang.Object bean

handler

private org.apache.commons.jxpath.DynamicPropertyHandler handler

names

private java.lang.String[] names
Constructor Detail

DynamicPointer

public DynamicPointer(org.apache.commons.jxpath.ri.QName name,
                      java.lang.Object bean,
                      org.apache.commons.jxpath.DynamicPropertyHandler handler,
                      java.util.Locale locale)

DynamicPointer

public DynamicPointer(org.apache.commons.jxpath.ri.model.NodePointer parent,
                      org.apache.commons.jxpath.ri.QName name,
                      java.lang.Object bean,
                      org.apache.commons.jxpath.DynamicPropertyHandler handler)
Method Detail

getPropertyPointer

public org.apache.commons.jxpath.ri.model.beans.PropertyPointer getPropertyPointer()

createNodeIterator

public org.apache.commons.jxpath.ri.model.NodeIterator createNodeIterator(java.lang.String property,
                                                                          boolean reverse,
                                                                          org.apache.commons.jxpath.ri.model.NodePointer startWith)

attributeIterator

public org.apache.commons.jxpath.ri.model.NodeIterator attributeIterator(org.apache.commons.jxpath.ri.QName name)
Description copied from class: org.apache.commons.jxpath.ri.model.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.


getName

public org.apache.commons.jxpath.ri.QName getName()
Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer
Returns the name of this node. Can be null.


isDynamicPropertyDeclarationSupported

public boolean isDynamicPropertyDeclarationSupported()

getBaseValue

public java.lang.Object getBaseValue()
Returns the DP object iself.


isLeaf

public boolean isLeaf()
Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer
If true, this node does not have children


isCollection

public boolean isCollection()
Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer
Returns true if the value of the pointer is an array or a Collection.


getLength

public int getLength()
Returns 1.


asPath

public java.lang.String asPath()
Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer
Returns an XPath that maps to this Pointer.


hashCode

public int hashCode()
Description copied from class: java.lang.Object
Get a value that represents this Object, as uniquely as possible within the confines of an int.

There are some requirements on this method which subclasses must follow:

  • Semantic equality implies identical hashcodes. In other words, if a.equals(b) is true, then a.hashCode() == b.hashCode() must be as well. However, the reverse is not necessarily true, and two objects may have the same hashcode without being equal.
  • It must be consistent. Whichever value o.hashCode() returns on the first invocation must be the value returned on all later invocations as long as the object exists. Notice, however, that the result of hashCode may change between separate executions of a Virtual Machine, because it is not invoked on the same object.

Notice that since hashCode is used in java.util.Hashtable and other hashing classes, a poor implementation will degrade the performance of hashing (so don't blindly implement it as returning a constant!). Also, if calculating the hash is time-consuming, a class may consider caching the results.

The default implementation returns System.identityHashCode(this)


equals

public boolean equals(java.lang.Object object)
Description copied from class: java.lang.Object
Determine whether this Object is semantically equal to another Object.

There are some fairly strict requirements on this method which subclasses must follow:

  • It must be transitive. If a.equals(b) and b.equals(c), then a.equals(c) must be true as well.
  • It must be symmetric. a.equals(b) and b.equals(a) must have the same value.
  • It must be reflexive. a.equals(a) must always be true.
  • It must be consistent. Whichever value a.equals(b) returns on the first invocation must be the value returned on all later invocations.
  • a.equals(null) must be false.
  • It must be consistent with hashCode(). That is, a.equals(b) must imply a.hashCode() == b.hashCode(). The reverse is not true; two objects that are not equal may have the same hashcode, but that has the potential to harm hashing performance.

This is typically overridden to throw a java.lang.ClassCastException if the argument is not comparable to the class performing the comparison, but that is not a requirement. It is legal for a.equals(b) to be true even though a.getClass() != b.getClass(). Also, it is typical to never cause a java.lang.NullPointerException.

In general, the Collections API (java.util) use the equals method rather than the == operator to compare objects. However, java.util.IdentityHashMap is an exception to this rule, for its own good reasons.

The default implementation returns this == o.