bloritsch 2003/10/24 13:37:56
Modified: src/java/org/apache/cocoon/components/treeprocessor
ProcessingNode.java
Log:
Make the interface documentation a bit more robust
Revision Changes Path
1.2 +19 -9
cocoon-2.2/src/java/org/apache/cocoon/components/treeprocessor/ProcessingNode.java
Index: ProcessingNode.java
===================================================================
RCS file:
/home/cvs/cocoon-2.2/src/java/org/apache/cocoon/components/treeprocessor/ProcessingNode.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ProcessingNode.java 9 Mar 2003 00:09:16 -0000 1.1
+++ ProcessingNode.java 24 Oct 2003 20:37:56 -0000 1.2
@@ -51,29 +51,39 @@
package org.apache.cocoon.components.treeprocessor;
import org.apache.avalon.framework.thread.ThreadSafe;
-
import org.apache.cocoon.environment.Environment;
/**
+ * The ProcessingNode is used to represent the interface for using a
processing tree.
+ * Each node will recursively call its child nodes until the entire
processing tree is
+ * executed for the particular request.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Sylvain Wallez</a>
* @version CVS $Id$
*/
-public interface ProcessingNode extends ThreadSafe {
+public interface ProcessingNode
+ extends ThreadSafe
+{
- /**
- * The key of the <code>SourceResolver</code> in the object model.
- */
+ /** The key used for the <code>SourceResolver</code> in the object
model. */
String OBJECT_SOURCE_RESOLVER = "source-resolver";
/**
- * Process environment.
+ * Process this node with the suppled environment information. Will
recursively
+ * process child nodes.
+ *
+ * @param env The Environment object used to process a request.
+ * @param context The runtime context information for this request.
+ * @return <code>true</code> if a redirect has been issued.
+ * @throws Exception if the processing was not successful.
*/
- boolean invoke(Environment env, InvokeContext context) throws Exception;
+ boolean invoke( Environment env, InvokeContext context ) throws
Exception;
/**
- * Get the location of this node.
+ * Get the location of this node. ?? Is this the XML locator text ??
+ *
+ * @return
*/
String getLocation();
}
