diff gnv-artifacts/src/main/java/de/intevation/gnv/state/StateFactory.java @ 796:a5526908f92f

Added javadoc in state package. gnv-artifacts/trunk@878 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Thu, 01 Apr 2010 09:15:36 +0000
parents c4156275c1e1
children feae2f9d6c6f
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/StateFactory.java	Wed Mar 31 13:48:07 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/StateFactory.java	Thu Apr 01 09:15:36 2010 +0000
@@ -7,6 +7,9 @@
 import org.w3c.dom.Node;
 
 /**
+ * This factory should be used to create new state objects with help of a
+ * configuration segment.
+ * 
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  *
  */
@@ -26,6 +29,11 @@
         super();
     }
 
+    /**
+     * Return the instance of this class.
+     *
+     * @return
+     */
     public static StateFactory getInstance() {
         if (instance == null) {
             instance = new StateFactory();
@@ -33,6 +41,13 @@
         return instance;
     }
 
+    /**
+     * This method creates a new state with help of the information in <i>
+     * configuration</i> and calls its setup method after creation.
+     *
+     * @param configuration
+     * @return the new state.
+     */
     public State createState(Node configuration) {
         log.debug("StateFactory.createState");
         State state = null;
@@ -51,3 +66,4 @@
     }
 
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :
\ No newline at end of file

http://dive4elements.wald.intevation.org