commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From skitch...@apache.org
Subject svn commit: r151339 - jakarta/commons/proper/digester/branches/digester2/src/java/org/apache/commons/digester2/Context.java
Date Fri, 04 Feb 2005 11:07:50 GMT
Author: skitching
Date: Fri Feb  4 03:07:48 2005
New Revision: 151339

URL: http://svn.apache.org/viewcvs?view=rev&rev=151339
Log:
Remove unused ruleManager member
Reorder some methods for tidiness
Add/revise javadoc

Modified:
    jakarta/commons/proper/digester/branches/digester2/src/java/org/apache/commons/digester2/Context.java

Modified: jakarta/commons/proper/digester/branches/digester2/src/java/org/apache/commons/digester2/Context.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/digester/branches/digester2/src/java/org/apache/commons/digester2/Context.java?view=diff&r1=151338&r2=151339
==============================================================================
--- jakarta/commons/proper/digester/branches/digester2/src/java/org/apache/commons/digester2/Context.java
(original)
+++ jakarta/commons/proper/digester/branches/digester2/src/java/org/apache/commons/digester2/Context.java
Fri Feb  4 03:07:48 2005
@@ -17,7 +17,6 @@
 
 package org.apache.commons.digester2;
 
-
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.IOException;
@@ -35,7 +34,6 @@
 import org.apache.commons.logging.LogFactory;
 import org.apache.commons.collections.ArrayStack;
 
-
 /**
  * <p>Holds information that evolves as the parsing of an input xml document
  * progresses. The Action objects regularly interact with this object when their
@@ -62,7 +60,9 @@
         this.log = log;
     }
 
-    // --------------------------------------------------- Instance Variables
+    // --------------------------------------------------- 
+    // Instance Variables
+    // --------------------------------------------------- 
 
     /**
      * The owner of this object.
@@ -77,11 +77,6 @@
     private Log log;
 
     /**
-     * The owner of the set of rules (pattern, action pairs).
-     */
-    private RuleManager ruleManager = null;
-
-    /**
      * Stack whose elements are List objects, each containing a list of
      * Action objects as returned from RuleManager.getMatchingActions().
      * As each xml element in the input is entered, the list of matching
@@ -97,12 +92,6 @@
     private Path currentElementPath = new Path();
 
     /**
-     * The parameters stack being utilized by CallMethodAction and
-     * CallParamAction.
-     */
-    private ArrayStack params = new ArrayStack();
-
-    /**
      * The object that forms the root of the tree of objects being
      * created during a parse. Note that if setRoot has been called, then
      * this is the same as looking at the bottom element on the object stack.
@@ -126,7 +115,15 @@
      */
     private HashMap stacksByName = new HashMap();
 
-    // ------------------------------------------------------------- Properties
+    /**
+     * The parameters stack being utilized by CallMethodAction and
+     * CallParamAction.
+     */
+    private ArrayStack params = new ArrayStack();
+
+    // ---------------------------------------------------
+    // Properties
+    // --------------------------------------------------- 
 
     /**
      * Return the current Logger associated with this instance of the Digester
@@ -158,18 +155,45 @@
         return currentElementPath.getPath();
     }
 
+    /**
+     * Remember the list of Actions which matched the current element. This
+     * method is expected to be called when the element's start tag has been
+     * seen and the matching actions computed. The list is used later to
+     * find the actions to invoke bodySegment/body/end methods on.
+     *
+     * @param actions should be a list of Action objects.
+     */
     public void pushMatchingActions(List actions) {
         matchedActionLists.push(actions);
     }
 
+    /**
+     * Discard the list of Actions which matched the current element. This
+     * method is expected to be called when the element's end tag has been
+     * seen and the matching actions for the element are no longer needed.
+     *
+     * @return a list of Action objects.
+     */
     public List popMatchingActions() {
         return (List) matchedActionLists.pop();
     }
 
+    /**
+     * Retrieve the list of Actions which matched the current element. 
+     *
+     * @return a list of Action objects.
+     */
     public List peekMatchingActions() {
         return (List) matchedActionLists.peek();
     }
 
+    /**
+     * Obtain the classloader object that should be used when an Action class
+     * needs to load a class to be instantiated to represent data in the input
+     * xml being parsed.
+     *
+     * @return a classloader (never null)
+     */
     public ClassLoader getClassLoader() {
         return saxHandler.getClassLoader();
     }
@@ -178,7 +202,9 @@
         return saxHandler;
     }
 
-    // --------------------------------------------------- Object Stack Methods
+    // --------------------------------------------------- 
+    // Object Stack Methods
+    // --------------------------------------------------- 
 
     /**
      * The root object of the Object stack.
@@ -190,6 +216,36 @@
     }
 
     /**
+     * Returns the root element of the tree of objects created as a result
+     * of applying the action objects to the input XML.
+     * <p>
+     * If the digester stack was "primed" by explicitly calling setRoot before
+     * parsing started, then that root object is returned here.
+     * <p>
+     * Alternatively, if an Action which creates an object (eg ObjectCreateAction)
+     * matched the root element of the xml, then the object created will be
+     * returned here.
+     * <p>
+     * In other cases, the object most recently pushed onto an empty digester
+     * stack is returned. This would be a most unusual use of digester, however;
+     * one of the previous configurations is much more likely.
+     * <p>
+     * Note that when using one of the Digester.parse methods, the return
+     * value from the parse method is exactly the same as the return value
+     * from this method. However when the Digester's SAXHandler has been used
+     * explicitly as the content-handler for a user-provided sax parser, no
+     * such return value is available; in this case, this method allows you
+     * to access the root object that has been created after parsing has
+     * completed.
+     *
+     * @return the root object that has been created after parsing
+     *  or null if the digester has not parsed any XML yet.
+     */
+    public Object getRoot() {
+        return root;
+    }
+
+    /**
      * <p>Is the object stack empty?</p>
      *
      * @return true if the object stack if empty
@@ -390,36 +446,6 @@
             stacksByName.put(stackName, namedStack);
         }
         namedStack.push(value);
-    }
-
-    /**
-     * Returns the root element of the tree of objects created as a result
-     * of applying the action objects to the input XML.
-     * <p>
-     * If the digester stack was "primed" by explicitly calling setRoot before
-     * parsing started, then that root object is returned here.
-     * <p>
-     * Alternatively, if an Action which creates an object (eg ObjectCreateAction)
-     * matched the root element of the xml, then the object created will be
-     * returned here.
-     * <p>
-     * In other cases, the object most recently pushed onto an empty digester
-     * stack is returned. This would be a most unusual use of digester, however;
-     * one of the previous configurations is much more likely.
-     * <p>
-     * Note that when using one of the Digester.parse methods, the return
-     * value from the parse method is exactly the same as the return value
-     * from this method. However when the Digester's SAXHandler has been used
-     * explicitly as the content-handler for a user-provided sax parser, no
-     * such return value is available; in this case, this method allows you
-     * to access the root object that has been created after parsing has
-     * completed.
-     *
-     * @return the root object that has been created after parsing
-     *  or null if the digester has not parsed any XML yet.
-     */
-    public Object getRoot() {
-        return root;
     }
 
     /**



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message