Javadoc

Author: garydgregory

src/main/java/org/apache/commons/jxpath/JXPathBasicBeanInfo.java

@@ -38,15 +38,34 @@ public class JXPathBasicBeanInfo implements JXPathBeanInfo {
     private static final Comparator PROPERTY_DESCRIPTOR_COMPARATOR = (left, right) -> ((PropertyDescriptor) left).getName()
             .compareTo(((PropertyDescriptor) right).getName());
 
+    /**
+     * Whether objects of this class are treated as atomic objects which have no properties of their own.
+     */
     private boolean atomic;
+
+    /**
+     * Bean class.
+     */
     private final Class clazz;
+
+    /**
+     * The DynamicPropertyHandler class for a dynamic class.
+     */
     private Class dynamicPropertyHandlerClass;
+
+    /**
+     * List of property descriptors for the beans described by this bean info object.
+     */
     private transient PropertyDescriptor[] propertyDescriptors;
+
+    /**
+     * PropertyDescriptor for the specified name or null if there is no such property.
+     */
     private transient HashMap propertyDescriptorMap;
 
     /**
      * Create a new JXPathBasicBeanInfo.
-     * 
+     *
      * @param clazz bean class
      */
     public JXPathBasicBeanInfo(final Class clazz) {
@@ -55,7 +74,7 @@ public JXPathBasicBeanInfo(final Class clazz) {
 
     /**
      * Create a new JXPathBasicBeanInfo.
-     * 
+     *
      * @param clazz  bean class
      * @param atomic whether objects of this class are treated as atomic objects which have no properties of their own.
      */
@@ -66,7 +85,7 @@ public JXPathBasicBeanInfo(final Class clazz, final boolean atomic) {
 
     /**
      * Create a new JXPathBasicBeanInfo.
-     * 
+     *
      * @param clazz                       bean class
      * @param dynamicPropertyHandlerClass dynamic property handler class
      */
@@ -77,9 +96,9 @@ public JXPathBasicBeanInfo(final Class clazz, final Class dynamicPropertyHandler
     }
 
     /**
-     * For a dynamic class, returns the corresponding DynamicPropertyHandler class.
-     * 
-     * @return Class
+     * Gets the DynamicPropertyHandler class for a dynamic class.
+     *
+     * @return the DynamicPropertyHandler class for a dynamic class.
      */
     @Override
     public Class getDynamicPropertyHandlerClass() {
@@ -131,9 +150,9 @@ public synchronized PropertyDescriptor[] getPropertyDescriptors() {
     }
 
     /**
-     * Returns true if objects of this class are treated as atomic objects which have no properties of their own.
-     * 
-     * @return boolean
+     * Tests whether objects of this class are treated as atomic objects which have no properties of their own.
+     *
+     * @return whether objects of this class are treated as atomic objects which have no properties of their own.
      */
     @Override
     public boolean isAtomic() {
@@ -142,7 +161,7 @@ public boolean isAtomic() {
 
     /**
      * Return true if the corresponding objects have dynamic properties.
-     * 
+     *
      * @return boolean
      */
     @Override

src/main/java/org/apache/commons/jxpath/JXPathBeanInfo.java

@@ -30,41 +30,41 @@
 public interface JXPathBeanInfo extends Serializable {
 
     /**
-     * For dynamic objects, returns the class implementing the {@link DynamicPropertyHandler} interface. That class can be used to access dynamic properties.
-     * 
-     * @return Class
+     * Gets the class implementing the {@link DynamicPropertyHandler} interface for dynamic objects. That class can be used to access dynamic properties.
+     *
+     * @return Class The class implementing the {@link DynamicPropertyHandler} interface.
      */
     Class getDynamicPropertyHandlerClass();
 
     /**
-     * Returns a PropertyDescriptor for the specified name or null if there is no such property.
-     * 
+     * Gets a PropertyDescriptor for the specified name or null if there is no such property.
+     *
      * @param propertyName property name
      * @return PropertyDescriptor
      */
     PropertyDescriptor getPropertyDescriptor(String propertyName);
 
     /**
-     * Returns a list of property descriptors for the beans described by this bean info object. Returns null for atomic beans.
-     * 
+     * Gets a list of property descriptors for the beans described by this bean info object. Returns null for atomic beans.
+     *
      * @return PropertyDescriptor[]
      */
     PropertyDescriptor[] getPropertyDescriptors();
 
     /**
-     * Returns true if objects of this class are treated as atomic objects which have no properties of their own. For example, {@link String} and {@link Number}
+     * Tests whether objects of this class are treated as atomic objects which have no properties of their own. For example, {@link String} and {@link Number}
      * are atomic.
-     * 
-     * @return boolean
+     *
+     * @return Tests whether objects of this class are treated as atomic objects.
      */
     boolean isAtomic();
 
     /**
-     * Returns true if the objects of this class have dynamic properties (e.g. java.util.Map). If this method returns true, {@link #getPropertyDescriptors}
-     * should return null and {@link #getDynamicPropertyHandlerClass} should return a valid class name. An object cannot have both static and dynamic properties
-     * at the same time.
-     * 
-     * @return boolean
+     * Tests whether the objects of this class have dynamic properties (e.g. java.util.Map). If this method returns true, {@link #getPropertyDescriptors} should
+     * return null and {@link #getDynamicPropertyHandlerClass} should return a valid class name. An object cannot have both static and dynamic properties at the
+     * same time.
+     *
+     * @return whether the objects of this class have dynamic properties.
      */
     boolean isDynamic();
 }

src/main/java/org/apache/commons/jxpath/Variables.java

@@ -28,32 +28,32 @@ public interface Variables extends Serializable {
     /**
      * Defines a new variable with the specified value or modifies the value of an existing variable. May throw UnsupportedOperationException.
      * 
-     * @param varName variable name
+     * @param name variable name
      * @param value   to declare
      */
-    void declareVariable(String varName, Object value);
+    void declareVariable(String name, Object value);
 
     /**
      * Returns the value of the specified variable.
      * 
-     * @param varName variable name
+     * @param name variable name
      * @return Object value
      * @throws IllegalArgumentException if there is no such variable.
      */
-    Object getVariable(String varName);
+    Object getVariable(String name);
 
     /**
      * Returns true if the specified variable is declared.
      * 
-     * @param varName variable name
+     * @param name variable name
      * @return boolean
      */
-    boolean isDeclaredVariable(String varName);
+    boolean isDeclaredVariable(String name);
 
     /**
      * Removes an existing variable. May throw UnsupportedOperationException.
      *
-     * @param varName is a variable name without the "$" sign
+     * @param name is a variable name without the "$" sign
      */
-    void undeclareVariable(String varName);
+    void undeclareVariable(String name);
 }

src/main/java/org/apache/commons/jxpath/ri/model/dynamic/DynamicPropertyPointer.java

@@ -36,7 +36,11 @@ public class DynamicPropertyPointer extends PropertyPointer {
 
     private static final long serialVersionUID = -5720585681149150822L;
     private final DynamicPropertyHandler handler;
+    
+    /** The name of the currently selected property or "*" if none has been selected. */
     private String name;
+    
+    /** The names of all properties, sorted alphabetically. */
     private String[] names;
     private String requiredPropertyName;
 
@@ -161,7 +165,7 @@ public int getPropertyIndex() {
     }
 
     /**
-     * Returns the name of the currently selected property or "*" if none has been selected.
+     * Gets the name of the currently selected property or "*" if none has been selected.
      * 
      * @return String
      */
@@ -175,7 +179,7 @@ public String getPropertyName() {
     }
 
     /**
-     * Names of all properties, sorted alphabetically.
+     * Gets the names of all properties, sorted alphabetically.
      * 
      * @return String[]
      */

src/main/java/org/apache/commons/jxpath/ri/model/jdom/JDOMAttributePointer.java

@@ -28,17 +28,19 @@
 public class JDOMAttributePointer extends NodePointer {
 
     private static final long serialVersionUID = 8896050354479644028L;
-    private final Attribute attr;
+
+    /** JDOM Attribute. */
+    private final Attribute attribute;
 
     /**
      * Create a JDOMAttributePointer.
-     * 
-     * @param parent NodePointer parent
-     * @param attr   JDOM Attribute
+     *
+     * @param parent NodePointer parent.
+     * @param attribute   JDOM Attribute.
      */
-    public JDOMAttributePointer(final NodePointer parent, final Attribute attr) {
+    public JDOMAttributePointer(final NodePointer parent, final Attribute attribute) {
         super(parent);
-        this.attr = attr;
+        this.attribute = attribute;
     }
 
     @Override
@@ -63,17 +65,17 @@ public int compareChildNodePointers(final NodePointer pointer1, final NodePointe
 
     @Override
     public boolean equals(final Object object) {
-        return object == this || object instanceof JDOMAttributePointer && ((JDOMAttributePointer) object).attr == attr;
+        return object == this || object instanceof JDOMAttributePointer && ((JDOMAttributePointer) object).attribute == attribute;
     }
 
     @Override
     public Object getBaseValue() {
-        return attr;
+        return attribute;
     }
 
     @Override
     public Object getImmediateNode() {
-        return attr;
+        return attribute;
     }
 
     @Override
@@ -83,12 +85,12 @@ public int getLength() {
 
     @Override
     public QName getName() {
-        return new QName(JDOMNodePointer.getPrefix(attr), JDOMNodePointer.getLocalName(attr));
+        return new QName(JDOMNodePointer.getPrefix(attribute), JDOMNodePointer.getLocalName(attribute));
     }
 
     @Override
     public String getNamespaceURI() {
-        String uri = attr.getNamespaceURI();
+        String uri = attribute.getNamespaceURI();
         if (uri != null && uri.isEmpty()) {
             uri = null;
         }
@@ -97,12 +99,12 @@ public String getNamespaceURI() {
 
     @Override
     public Object getValue() {
-        return attr.getValue();
+        return attribute.getValue();
     }
 
     @Override
     public int hashCode() {
-        return System.identityHashCode(attr);
+        return System.identityHashCode(attribute);
     }
 
     @Override
@@ -122,11 +124,11 @@ public boolean isLeaf() {
 
     @Override
     public void remove() {
-        attr.getParent().removeAttribute(attr);
+        attribute.getParent().removeAttribute(attribute);
     }
 
     @Override
     public void setValue(final Object value) {
-        attr.setValue((String) TypeUtils.convert(value, String.class));
+        attribute.setValue((String) TypeUtils.convert(value, String.class));
     }
 }

src/main/java/org/apache/commons/jxpath/ri/model/jdom/JDOMNamespacePointer.java

@@ -26,12 +26,16 @@
 public class JDOMNamespacePointer extends NodePointer {
 
     private static final long serialVersionUID = 7935311686545862379L;
+
+    /** Namespace prefix. */
     private final String prefix;
+
+    /** Namespace URI string. */
     private String namespaceURI;
 
     /**
      * Create a new JDOMNamespacePointer.
-     * 
+     *
      * @param parent parent pointer
      * @param prefix ns prefix
      */
@@ -42,7 +46,7 @@ public JDOMNamespacePointer(final NodePointer parent, final String prefix) {
 
     /**
      * Create a new JDOMNamespacePointer.
-     * 
+     *
      * @param parent       parent pointer
      * @param prefix       ns prefix
      * @param namespaceURI ns URI
@@ -123,7 +127,7 @@ public boolean isLeaf() {
 
     /**
      * Throws UnsupportedOperationException.
-     * 
+     *
      * @param value Object value to set
      */
     @Override