Javadoc

Author: garydgregory

src/main/java/org/apache/commons/jxpath/ri/model/dynabeans/DynaBeanPointer.java

@@ -34,7 +34,7 @@ public class DynaBeanPointer extends PropertyOwnerPointer {
 
     /**
      * Learn whether two objects are == || .equals().
-     * 
+     *
      * @param o1 first object
      * @param o2 second object
      * @return boolean
@@ -43,12 +43,19 @@ private static boolean equalObjects(final Object o1, final Object o2) {
         return o1 == o2 || o1 != null && o1.equals(o2);
     }
 
+    /**
+     * Qualified name.
+     */
     private final QName qName;
+
+    /**
+     * DynaBean.
+     */
     private final DynaBean dynaBean;
 
     /**
      * Constructs a new DynaBeanPointer.
-     * 
+     *
      * @param parent   pointer
      * @param qName     is the name given to the first node
      * @param dynaBean pointed
@@ -61,7 +68,7 @@ public DynaBeanPointer(final NodePointer parent, final QName qName, final DynaBe
 
     /**
      * Constructs a new DynaBeanPointer.
-     * 
+     *
      * @param qName     is the name given to the first node
      * @param dynaBean pointed
      * @param locale   Locale

src/main/java/org/apache/commons/jxpath/ri/model/dynabeans/DynaBeanPropertyPointer.java

@@ -36,13 +36,25 @@ public class DynaBeanPropertyPointer extends PropertyPointer {
 
     private static final String CLASS = "class";
     private static final long serialVersionUID = 2094421509141267239L;
+
+    /**
+     * DynaBean.
+     */
     private final DynaBean dynaBean;
+
+    /**
+     * The name of the currently selected property or "*" if none has been selected.
+     */
     private String name;
+
+    /**
+     * The names of the included properties.
+     */
     private String[] names;
 
     /**
      * Constructs a new DynaBeanPropertyPointer.
-     * 
+     *
      * @param parent   pointer
      * @param dynaBean pointed
      */
@@ -53,7 +65,7 @@ public DynaBeanPropertyPointer(final NodePointer parent, final DynaBean dynaBean
 
     /**
      * Convert a value to the appropriate property type.
-     * 
+     *
      * @param value   to convert
      * @param element whether this should be a collection element.
      * @return conversion result
@@ -84,7 +96,7 @@ public Object getBaseValue() {
     /**
      * If index == WHOLE_COLLECTION, the value of the property, otherwise the value of the index'th element of the collection represented by the property. If
      * the property is not a collection, index should be zero and the value will be the property itself.
-     * 
+     *
      * @return Object
      */
     @Override
@@ -127,7 +139,7 @@ public int getPropertyCount() {
 
     /**
      * Index of the currently selected property in the list of all properties sorted alphabetically.
-     * 
+     *
      * @return int
      */
     @Override
@@ -147,7 +159,7 @@ public int getPropertyIndex() {
 
     /**
      * Returns the name of the currently selected property or "*" if none has been selected.
-     * 
+     *
      * @return String
      */
     @Override
@@ -172,15 +184,15 @@ public String[] getPropertyNames() {
                     properties.add(name);
                 }
             }
-            names = (String[]) properties.toArray(new String[properties.size()]);
+            names = properties.toArray(new String[properties.size()]);
             Arrays.sort(names);
         }
         return names;
     }
 
     /**
      * Returns true if the bean has the currently selected property.
-     * 
+     *
      * @return boolean
      */
     @Override
@@ -191,7 +203,7 @@ protected boolean isActualProperty() {
 
     /**
      * This type of node is auxiliary.
-     * 
+     *
      * @return true
      */
     @Override
@@ -201,7 +213,7 @@ public boolean isContainer() {
 
     /**
      * Learn whether the property referenced is an indexed property.
-     * 
+     *
      * @return boolean
      */
     protected boolean isIndexedProperty() {
@@ -226,7 +238,7 @@ public void remove() {
 
     /**
      * Index a property by its index in the list of all properties sorted alphabetically.
-     * 
+     *
      * @param index to set
      */
     @Override
@@ -239,7 +251,7 @@ public void setPropertyIndex(final int index) {
 
     /**
      * Select a property by name.
-     * 
+     *
      * @param propertyName to select
      */
     @Override
@@ -250,7 +262,7 @@ public void setPropertyName(final String propertyName) {
 
     /**
      * Sets an indexed value.
-     * 
+     *
      * @param index to change
      * @param value to set
      */
@@ -268,7 +280,7 @@ private void setValue(final int index, final Object value) {
     /**
      * If index == WHOLE_COLLECTION, change the value of the property, otherwise change the value of the index'th element of the collection represented by the
      * property.
-     * 
+     *
      * @param value to set
      */
     @Override

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

@@ -35,13 +35,25 @@
 public class DynamicPointer extends PropertyOwnerPointer {
 
     private static final long serialVersionUID = -1842347025295904256L;
+
+    /**
+     * Qualified name.
+     */
     private final QName qName;
+
+    /**
+     * Java bean.
+     */
     private final Object bean;
+
+    /**
+     * Dynamic property handler.
+     */
     private final DynamicPropertyHandler handler;
 
     /**
      * Constructs a new DynamicPointer.
-     * 
+     *
      * @param parent  parent pointer
      * @param qName    property name
      * @param bean    owning bean
@@ -56,7 +68,7 @@ public DynamicPointer(final NodePointer parent, final QName qName, final Object
 
     /**
      * Constructs a new DynamicPointer.
-     * 
+     *
      * @param qName    property name
      * @param bean    owning bean
      * @param handler DynamicPropertyHandler
@@ -101,7 +113,7 @@ public boolean equals(final Object object) {
 
     /**
      * Returns the DP object iself.
-     * 
+     *
      * @return Object
      */
     @Override
@@ -111,7 +123,7 @@ public Object getBaseValue() {
 
     /**
      * Returns 1.
-     * 
+     *
      * @return int
      */
     @Override

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

@@ -35,18 +35,26 @@
 public class DynamicPropertyPointer extends PropertyPointer {
 
     private static final long serialVersionUID = -5720585681149150822L;
+
+    /**
+     * Dynamic property handler.
+     */
     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;
+
+    /**
+     * The property name from {@link #setPropertyName(String)}.
+     */
     private String requiredPropertyName;
 
     /**
      * Constructs a new DynamicPropertyPointer.
-     * 
+     *
      * @param parent  pointer
      * @param handler DynamicPropertyHandler
      */
@@ -110,7 +118,7 @@ public NodePointer createPath(final JXPathContext context, final Object value) {
 
     /**
      * Returns the value of the property, not an element of the collection represented by the property, if any.
-     * 
+     *
      * @return Object
      */
     @Override
@@ -121,7 +129,7 @@ public Object getBaseValue() {
     /**
      * If index == WHOLE_COLLECTION, the value of the property, otherwise the value of the index'th element of the collection represented by the property. If
      * the property is not a collection, index should be zero and the value will be the property itself.
-     * 
+     *
      * @return Object
      */
     @Override
@@ -137,7 +145,7 @@ public Object getImmediateNode() {
 
     /**
      * Number of the DP object's properties.
-     * 
+     *
      * @return int
      */
     @Override
@@ -147,7 +155,7 @@ public int getPropertyCount() {
 
     /**
      * Index of the currently selected property in the list of all properties sorted alphabetically.
-     * 
+     *
      * @return int
      */
     @Override
@@ -166,7 +174,7 @@ public int getPropertyIndex() {
 
     /**
      * Gets the name of the currently selected property or "*" if none has been selected.
-     * 
+     *
      * @return String
      */
     @Override
@@ -180,7 +188,7 @@ public String getPropertyName() {
 
     /**
      * Gets the names of all properties, sorted alphabetically.
-     * 
+     *
      * @return String[]
      */
     @Override
@@ -206,7 +214,7 @@ public String[] getPropertyNames() {
 
     /**
      * A dynamic property is always considered actual - all keys are apparently existing with possibly the value of null.
-     * 
+     *
      * @return boolean
      */
     @Override
@@ -216,7 +224,7 @@ protected boolean isActualProperty() {
 
     /**
      * This type of node is auxiliary.
-     * 
+     *
      * @return true
      */
     @Override
@@ -250,7 +258,7 @@ private void removeKey() {
 
     /**
      * Index a property by its index in the list of all properties sorted alphabetically.
-     * 
+     *
      * @param index to set
      */
     @Override
@@ -264,7 +272,7 @@ public void setPropertyIndex(final int index) {
     /**
      * Select a property by name. If the supplied name is not one of the object's existing properties, it implicitly adds this name to the object's property
      * name list. It does not set the property value though. In order to set the property value, call setValue().
-     * 
+     *
      * @param propertyName to set
      */
     @Override
@@ -280,7 +288,7 @@ public void setPropertyName(final String propertyName) {
     /**
      * If index == WHOLE_COLLECTION, change the value of the property, otherwise change the value of the index'th element of the collection represented by the
      * property.
-     * 
+     *
      * @param value to set
      */
     @Override