diff gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/ExtendedKeyValueData.java @ 809:d05b17a4f3d0

Added javadoc in describedata package. gnv-artifacts/trunk@891 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Fri, 09 Apr 2010 07:27:38 +0000
parents 6cff63d0c434
children 2423cefe7d39
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/ExtendedKeyValueData.java	Thu Apr 08 16:35:02 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/ExtendedKeyValueData.java	Fri Apr 09 07:27:38 2010 +0000
@@ -3,6 +3,9 @@
 import org.apache.log4j.Logger;
 
 /**
+ * This implementation improves the <code>DefaultKeyValueDescribeData</code> and
+ * establishes another field to store a further parameter.
+ * 
  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
  */
 public class ExtendedKeyValueData
@@ -10,9 +13,19 @@
 {
     private static Logger logger = Logger.getLogger(ExtendedKeyValueData.class);
 
+    /**
+     * A further parameter to be stored at this object.
+     */
     protected String parameter;
 
-
+    /**
+     * Default constructor to initialize new objects.
+     *
+     * @param key The key.
+     * @param value The value.
+     * @param state The state - null permitted.
+     * @param parameter A further value.
+     */
     public ExtendedKeyValueData(
         String key, String value, String state, String parameter)
     {
@@ -20,6 +33,11 @@
         this.parameter = parameter;
     }
 
+    /**
+     * Returns the parameter.
+     *
+     * @return the parameter.
+     */
     public String getParameter() {
         return parameter;
     }

http://dive4elements.wald.intevation.org