diff artifacts/src/main/java/de/intevation/artifacts/Artifact.java @ 78:55eefe63a777

Repaired the javadoc stuff for almost all artifact interfaces. artifacts/trunk@760 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Thu, 11 Mar 2010 10:53:59 +0000
parents 48d1a9a082c2
children e9c80fdfee13
line wrap: on
line diff
--- a/artifacts/src/main/java/de/intevation/artifacts/Artifact.java	Sun Feb 21 23:05:32 2010 +0000
+++ b/artifacts/src/main/java/de/intevation/artifacts/Artifact.java	Thu Mar 11 10:53:59 2010 +0000
@@ -17,17 +17,17 @@
  *        of this artifact.</li>
  *   <li>{@link #hash() hash()}: Returns a hash value over the internal state
  *        of this artifact.</li>
- *   <li>{@link #describe(Object)}: Returns a description of this artifact.</li>
- *   <li>{@link #advance(Document, Object) advance()}: Advances this artifact
+ *   <li>{@link #describe(Document, CallContext)}: Returns a description of this artifact.</li>
+ *   <li>{@link #advance(Document, CallContext) advance()}: Advances this artifact
  *       to the next internal state</li>
- *   <li>{@link #feed(Document, Object) feed()}: Feed new data into this artifact.</li>
+ *   <li>{@link #feed(Document, CallContext) feed()}: Feed new data into this artifact.</li>
  *   <li>{@link #out(Document, OutputStream, CallContext) out()}: Produces output for this artifact.</li>
  * </ol>
  *
  * There are two more methods involved with the life cycle of the are:
  * <ol>
- *   <li>{@link #setup(String, ArtifactFactory, Object) setup()}: Called after created by the
- *                                               factory.</li>
+ *   <li>{@link #setup(String, ArtifactFactory, Object, Document) setup()}: 
+ *   Called after created by the factory.</li>
  *   <li>{@link #endOfLife(Object) endOfLife()}: Called when the artifact
  *                                               is going to be removed from
  *                                               system. Useful to clean up.</li>
@@ -53,6 +53,7 @@
 
     /**
      * A description used to build a interface to interact with this artifact.
+     * @param data General input data. Useful to produces specific descriptions.
      * @param context The global context of the runtime system.
      * @return An XML representation of the current state of the artifact.
      */
@@ -77,7 +78,9 @@
     /**
      * Produce output from this artifact.
      * @param format Specifies the format of the output.
+     * @param out Stream to write the result data to.
      * @param context The global context of the runtime system.
+     * @throws IOException Thrown if an I/O occurs.
      */
     void out(
         Document     format,
@@ -91,14 +94,14 @@
      * @param identifier The identifier from artifact database
      * @param factory    The factory which created this artifact.
      * @param context    The global context of the runtime system.
-     * @param data       The data which can be use to setup an Artifact with 
+     * @param data       The data which can be use to setup an artifact with 
      *                   more details.
      */
     public void setup(
         String          identifier,
         ArtifactFactory factory,
         Object          context,
-        Document     data);
+        Document        data);
 
     /**
      * Called from artifact database when an artifact is

http://dive4elements.wald.intevation.org