svn commit: r617892 - /commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/ChildContext.java

[mb...@apache.org]

Author: mbenson
Date: Sat Feb  2 12:49:48 2008
New Revision: 617892

URL: http://svn.apache.org/viewvc?rev=617892&view=rev
Log:
javadoc

Modified:
    commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/ChildContext.java

Modified: commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/ChildContext.java
URL: http://svn.apache.org/viewvc/commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/ChildContext.java?rev=617892&r1=617891&r2=617892&view=diff
==============================================================================
--- commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/ChildContext.java (original)
+++ commons/proper/jxpath/trunk/src/java/org/apache/commons/jxpath/ri/axes/ChildContext.java Sat Feb  2 12:49:48 2008
@@ -35,6 +35,13 @@
     private boolean reverse;
     private NodeIterator iterator;
 
+    /**
+     * Create a new ChildContext.
+     * @param parentContext parent EvalContext
+     * @param nodeTest NodeTest
+     * @param startFromParentLocation whether to start from parent location
+     * @param reverse whether to iterate in reverse
+     */
     public ChildContext(
         EvalContext parentContext,
         NodeTest nodeTest,
@@ -47,6 +54,9 @@
         this.reverse = reverse;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public NodePointer getCurrentNodePointer() {
         if (position == 0) {
             if (!setPosition(1)) {
@@ -62,6 +72,7 @@
      * even if it is a collection. It will not extract the first element
      * of the collection.  For example, "books" will return the collection
      * of books rather than the first book from that collection.
+     * @return Pointer
      */
     public Pointer getSingleNodePointer() {
         if (position == 0) {
@@ -81,15 +92,24 @@
         return getCurrentNodePointer();
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public boolean nextNode() {
         return setPosition(getCurrentPosition() + 1);
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public void reset() {
         super.reset();
         iterator = null;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public boolean setPosition(int position) {
         int oldPosition = getCurrentPosition();
         super.setPosition(position);