You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@xalan.apache.org by sb...@locus.apache.org on 2000/12/09 04:51:48 UTC
cvs commit: xml-xalan/java/src/org/apache/xpath/axes FilterExprWalker.java
sboag 00/12/08 19:51:48
Modified: java/src/org/apache/xpath/axes FilterExprWalker.java
Log:
Some javadoc added.
Revision Changes Path
1.9 +17 -26 xml-xalan/java/src/org/apache/xpath/axes/FilterExprWalker.java
Index: FilterExprWalker.java
===================================================================
RCS file: /home/cvs/xml-xalan/java/src/org/apache/xpath/axes/FilterExprWalker.java,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- FilterExprWalker.java 2000/11/23 04:59:00 1.8
+++ FilterExprWalker.java 2000/12/09 03:51:48 1.9
@@ -84,7 +84,7 @@
/**
* Construct a FilterExprWalker using a LocPathIterator.
*
- * NEEDSDOC @param locPathIterator
+ * @param locPathIterator non-null reference to the parent iterator.
*/
public FilterExprWalker(LocPathIterator locPathIterator)
{
@@ -94,9 +94,9 @@
/**
* Init a FilterExprWalker.
*
- * NEEDSDOC @param compiler
- * NEEDSDOC @param opPos
- * NEEDSDOC @param stepType
+ * @param compiler non-null reference to the Compiler that is constructing.
+ * @param opPos positive opcode position for this step.
+ * @param stepType The type of step.
*
* @throws javax.xml.transform.TransformerException
*/
@@ -123,7 +123,8 @@
/**
* Set the root node of the TreeWalker.
*
- * NEEDSDOC @param root
+ * @param root non-null reference to the root, or starting point of
+ * the query.
*/
public void setRoot(Node root)
{
@@ -149,7 +150,7 @@
{
// TODO: Fix...
- throw new RuntimeException(se.getMessage());
+ throw new org.apache.xml.utils.WrappedRuntimeException(se);
}
finally
{
@@ -163,7 +164,7 @@
/**
* Get a cloned FilterExprWalker.
*
- * NEEDSDOC ($objectName$) @return
+ * @return A new FilterExprWalker that can be used without mutating this one.
*
* @throws CloneNotSupportedException
*/
@@ -180,17 +181,6 @@
}
/**
- * NEEDSDOC Method setLocPathIterator
- *
- *
- * NEEDSDOC @param li
- */
- public void setLocPathIterator(LocPathIterator li)
- {
- super.setLocPathIterator(li);
- }
-
- /**
* This method needs to override AxesWalker.acceptNode because FilterExprWalkers
* don't need to, and shouldn't, do a node test.
* @param n The node to check to see if it passes the filter or not.
@@ -280,19 +270,20 @@
return setCurrentIfNotNull(next);
}
- /** NEEDSDOC Field m_expr */
- Expression m_expr;
+ /** The contained expression. Should be non-null. */
+ private Expression m_expr;
- /** NEEDSDOC Field m_nodeSet */
- NodeIterator m_nodeSet;
+ /** The result of executing m_expr. Needs to be deep cloned on clone op. */
+ private NodeIterator m_nodeSet;
- /** NEEDSDOC Field m_peek */
- Node m_peek = null;
+ /** I think this is always null right now. */
+ private Node m_peek = null;
/**
- * Tell what's the maximum level this axes can descend to.
+ * Tell what's the maximum level this axes can descend to (which is actually
+ * impossible to predict with this walker?).
*
- * NEEDSDOC ($objectName$) @return
+ * @return always a level of 1 right now.
*/
protected int getLevelMax()
{