diff gnv-artifacts/src/main/java/de/intevation/gnv/transition/TransitionFactory.java @ 824:7e5995c47125

Added more Javadoc. gnv-artifacts/trunk@913 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Tue, 13 Apr 2010 08:49:42 +0000
parents 79c1db3ca7cc
children 2423cefe7d39
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/transition/TransitionFactory.java	Tue Apr 13 08:25:34 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/transition/TransitionFactory.java	Tue Apr 13 08:49:42 2010 +0000
@@ -1,12 +1,12 @@
 package de.intevation.gnv.transition;
 
+import org.apache.log4j.Logger;
+import org.w3c.dom.Node;
+
 import de.intevation.gnv.artifacts.GNVArtifactBase;
 
-import org.apache.log4j.Logger;
-
-import org.w3c.dom.Node;
-
 /**
+ * This Factoryclass instantiates Objects of Type Transition.
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  *
  */
@@ -17,6 +17,9 @@
      */
     private static Logger log = Logger.getLogger(GNVArtifactBase.class);
 
+    /**
+     * The Singleton instance of the Transitionfactory.
+     */
     private static TransitionFactory instance = null;
 
     /**
@@ -26,6 +29,10 @@
         super();
     }
 
+    /**
+     * Returns the Instance of this Class.
+     * @return the Instance of this Class.
+     */
     public static TransitionFactory getInstance() {
         if (instance == null) {
             instance = new TransitionFactory();
@@ -33,6 +40,13 @@
         return instance;
     }
 
+    /**
+     * Creates a new Transition using the Configuration that is provided by the
+     * XML-Node.
+     * @param configuration The configuration that should be used to initialize 
+     *                      the new Transition
+     * @return a new Transition.
+     */
     public Transition createTransition(Node configuration) {
         log.debug("TransitionFactory.createTransition");
         Transition state = null;

http://dive4elements.wald.intevation.org