Mercurial > dive4elements > gnv-client
changeset 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 | 22567e7fa381 |
| children | 271ec4d11a9f |
| files | gnv/ChangeLog gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactFactory.java gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactStatisticValue.java gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultArtifactStatisticValue.java gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ParametrizedArtifactFactory.java gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ParametrizedArtifactObject.java |
| diffstat | 6 files changed, 43 insertions(+), 10 deletions(-) [+] |
line wrap: on
line diff
--- a/gnv/ChangeLog Tue Apr 13 08:47:40 2010 +0000 +++ b/gnv/ChangeLog Tue Apr 13 12:10:15 2010 +0000 @@ -1,3 +1,12 @@ +2010-04-13 Tim Englich <tim.englich@intevation.de> + + * src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactFactory.java, + src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactStatisticValue.java, + src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultArtifactStatisticValue.java, + src/main/java/de/intevation/gnv/artifactdatabase/objects/ParametrizedArtifactFactory.java, + src/main/java/de/intevation/gnv/artifactdatabase/objects/ParametrizedArtifactObject.java : + Added more Javadocs. + 2010-04-13 Ingo Weinzierl <ingo.weinzierl@intevation.de> * src/main/java/de/intevation/gnv/artifactdatabase/objects/package.html,
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactFactory.java Tue Apr 13 08:47:40 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactFactory.java Tue Apr 13 12:10:15 2010 +0000 @@ -29,10 +29,9 @@ /** * 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 ArtifactFactory(String name, String description, String dataBaseUrl) { super();
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactStatisticValue.java Tue Apr 13 08:47:40 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactStatisticValue.java Tue Apr 13 12:10:15 2010 +0000 @@ -3,13 +3,23 @@ import java.io.Serializable; /** + * This is the Interfacedefinition for Statistic values that belongs + * to an Artifact. * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> * */ public interface ArtifactStatisticValue extends Serializable { + /** + * Returns the Key of the Object + * @return the Key of the Object + */ String getKey(); + /** + * Returns the stored Value + * @return the stored Value + */ String getValue(); } // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 : \ No newline at end of file
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultArtifactStatisticValue.java Tue Apr 13 08:47:40 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/DefaultArtifactStatisticValue.java Tue Apr 13 12:10:15 2010 +0000 @@ -1,6 +1,7 @@ package de.intevation.gnv.artifactdatabase.objects; /** + * The Defaultimplementation of <code>ArtifactStatisticValue</code> * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> * */ @@ -15,6 +16,11 @@ private String value = null; + /** + * Constructor + * @param key the key of the new Value + * @param value the value of the Object. + */ public DefaultArtifactStatisticValue(String key, String value) { super(); this.key = key; @@ -28,5 +34,4 @@ public String getValue() { return this.value; } - }
--- 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) {
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ParametrizedArtifactObject.java Tue Apr 13 08:47:40 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ParametrizedArtifactObject.java Tue Apr 13 12:10:15 2010 +0000 @@ -4,6 +4,9 @@ import java.util.Map; /** + * Interface which extends the funtionality of the Interface + * <code>ArtifactObject</code> with methods for storing and retrieving + * optional Parameters. * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> */ public interface ParametrizedArtifactObject extends ArtifactObject { @@ -18,8 +21,8 @@ /** * Add a further parameter to the parameter map. * - * @param key - * @param values + * @param key the Key of the Parameter (unique) + * @param values the Values of the Parameter */ void addParameters(String key, Collection<String> values); }