Author: thorsten
Date: Sat Sep 27 14:23:07 2008
New Revision: 699742
URL: http://svn.apache.org/viewvc?rev=699742&view=rev
Log:
Adding javadoc comments
Modified:
forrest/trunk/whiteboard/dispatcher/java/org/apache/forrest/dispatcher/api/Structurer.java
Modified:
forrest/trunk/whiteboard/dispatcher/java/org/apache/forrest/dispatcher/api/Structurer.java
URL:
http://svn.apache.org/viewvc/forrest/trunk/whiteboard/dispatcher/java/org/apache/forrest/dispatcher/api/Structurer.java?rev=699742&r1=699741&r2=699742&view=diff
==============================================================================
---
forrest/trunk/whiteboard/dispatcher/java/org/apache/forrest/dispatcher/api/Structurer.java
(original)
+++
forrest/trunk/whiteboard/dispatcher/java/org/apache/forrest/dispatcher/api/Structurer.java
Sat Sep 27 14:23:07 2008
@@ -20,8 +20,28 @@
import org.apache.forrest.dispatcher.exception.DispatcherException;
+/**
+ * Wrapper interface to enable multible structurer implementation.
+ * The StAX only implementation and the AXIOM implementation are
+ * the first ones.
+ *
+ * @version 1.0
+ *
+ */
public interface Structurer {
+ /**
+ * Will process the incoming structurer for the format
+ * requested. The incoming structurerStream will be closed
+ * by this method. Implementations has to close the incoming
+ * stream before returning the returning stream to be conform
+ * with this api.
+ * @param structurerStream the stream that contains the structurer
+ * we need to process.
+ * @param format the format we want to process.
+ * @return the result of the processing in the requested format.
+ * @throws DispatcherException
+ */
InputStream execute(InputStream structurerStream,
String format) throws DispatcherException;
