diff gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ParametrizedArtifactFactory.java @ 693:d4d1eb56d725

Added more JavaDocs gnv/trunk@919 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Tue, 13 Apr 2010 12:10:15 +0000
parents 254f062e334b
children af22fa5567a6
line wrap: on
line diff
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ParametrizedArtifactFactory.java	Tue Apr 13 08:47:40 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ParametrizedArtifactFactory.java	Tue Apr 13 12:10:15 2010 +0000
@@ -5,6 +5,9 @@
 import java.util.Map;
 
 /**
+ * This Class is an Extention of the Class ArtifactFactory.
+ * Its only job is to store optional Parameters that might be 
+ * used to instantiate a new Artifact.
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  */
 public class ParametrizedArtifactFactory
@@ -15,13 +18,17 @@
      */
     private static final long serialVersionUID = 4516368434861819032L;
 
+    /**
+     * The Parameters that belongs to the Artifactfactory and might be used
+     * during the Initializationprocess of an Artifact.
+     */
     private Map<String, Collection<String>> parameters = null;
 
     /**
      * Constructor
-     * @param name
-     * @param description
-     * @param dataBaseUrl
+     * @param name the name of the factory
+     * @param description the description of the Factory
+     * @param dataBaseUrl the URL where the Factory could be reached.
      */
     public ParametrizedArtifactFactory(String name, String description,
                                        String dataBaseUrl) {

http://dive4elements.wald.intevation.org