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

Quick Search    Search Deep

org.apache.commons.jxpath.ri.model.beans
Class LangAttributePointer  view LangAttributePointer download LangAttributePointer.java

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

public class LangAttributePointer
extends org.apache.commons.jxpath.ri.model.NodePointer

A Pointer that points to the "lang" attribute of a JavaBean. The value of the attribute is based on the locale supplied to it in the constructor.

Version:
$Revision: 1.13 $ $Date: 2004/04/01 02:55:32 $

Field Summary
 
Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION
 
Constructor Summary
LangAttributePointer(org.apache.commons.jxpath.ri.model.NodePointer parent)
           
 
Method Summary
 java.lang.String asPath()
          Returns an XPath that maps to this Pointer.
 int compareChildNodePointers(org.apache.commons.jxpath.ri.model.NodePointer pointer1, org.apache.commons.jxpath.ri.model.NodePointer pointer2)
          Compares two child NodePointers and returns a positive number, zero or a positive number according to the order of the pointers.
 boolean equals(java.lang.Object object)
          Determine whether this Object is semantically equal to another Object.
 java.lang.Object getBaseValue()
          Returns the value represented by the pointer before indexing.
 java.lang.Object getImmediateNode()
          Returns the object the pointer points to; does not convert it to a "canonical" type.
 int getLength()
          If the pointer represents a collection (or collection element), returns the length of the collection.
 org.apache.commons.jxpath.ri.QName getName()
          Returns the name of this node.
 java.lang.String getNamespaceURI()
          Returns the namespace URI associated with this Pointer.
 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 isLeaf()
          If true, this node does not have children
 void setValue(java.lang.Object value)
          Throws UnsupportedOperationException.
 boolean testNode(org.apache.commons.jxpath.ri.compiler.NodeTest test)
          Checks 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, getDefaultNamespaceURI, getImmediateParentPointer, getImmediateValuePointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNode, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValue, getValuePointer, isActual, isAttribute, isContainer, isDefaultNamespace, isLanguage, isNode, isRoot, namespaceIterator, namespacePointer, newChildNodePointer, newNodePointer, printPointerChain, remove, setAttribute, setIndex, setNamespaceResolver, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LangAttributePointer

public LangAttributePointer(org.apache.commons.jxpath.ri.model.NodePointer parent)
Method Detail

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.


getNamespaceURI

public java.lang.String getNamespaceURI()
Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer
Returns the namespace URI associated with this Pointer.


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


getBaseValue

public java.lang.Object getBaseValue()
Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer
Returns the value represented by the pointer before indexing. So, if the node represents an element of a collection, this method returns the collection itself.


getImmediateNode

public java.lang.Object getImmediateNode()
Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer
Returns the object the pointer points to; does not convert it to a "canonical" type.


isLeaf

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


setValue

public void setValue(java.lang.Object value)
Throws UnsupportedOperationException.


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.


testNode

public boolean testNode(org.apache.commons.jxpath.ri.compiler.NodeTest test)
Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer
Checks if this Pointer matches the supplied NodeTest.


compareChildNodePointers

public int compareChildNodePointers(org.apache.commons.jxpath.ri.model.NodePointer pointer1,
                                    org.apache.commons.jxpath.ri.model.NodePointer pointer2)
Description copied from class: org.apache.commons.jxpath.ri.model.NodePointer
Compares two child NodePointers and returns a positive number, zero or a positive number according to the order of the pointers.