diff gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/DefaultSingleValueDescribeData.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 c4156275c1e1
children 05bf8534a35a
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/DefaultSingleValueDescribeData.java	Thu Apr 08 16:35:02 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/DefaultSingleValueDescribeData.java	Fri Apr 09 07:27:38 2010 +0000
@@ -1,14 +1,13 @@
 package de.intevation.gnv.state.describedata;
 
 /**
+ * This is the default implementation of <code>SingleValueDescribeData</code>.
+ * This object is used to store a single value for a specific name.
+ *
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
- *
  */
 public class DefaultSingleValueDescribeData implements SingleValueDescribeData {
 
-    /**
-     *
-     */
     private static final long serialVersionUID = 3580176842483316917L;
 
     private String name = null;
@@ -17,15 +16,22 @@
 
     private String state = null;
 
+    /**
+     * Constructor to create new objects without a specific state.
+     *
+     * @param name The name of this object.
+     * @param value The value of this object.
+     */
     public DefaultSingleValueDescribeData(String name, String value) {
         this(name, value, null);
     }
 
     /**
-     * Constructor
+     * Constructor to create new objects with a specific state.
      *
-     * @param name
-     * @param value
+     * @param name The name of this object.
+     * @param value The value of this object.
+     * @param state The state this object belongs to.
      */
     public DefaultSingleValueDescribeData(
         String name,
@@ -38,16 +44,10 @@
         this.state = state;
     }
 
-    /**
-     * @see de.intevation.gnv.state.describedata.SingleValueDescribeData#getName()
-     */
     public String getName() {
         return this.name;
     }
 
-    /**
-     * @see de.intevation.gnv.state.describedata.SingleValueDescribeData#getValue()
-     */
     public String getValue() {
         return this.value;
     }
@@ -60,3 +60,4 @@
         return this.state;
     }
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
\ No newline at end of file

http://dive4elements.wald.intevation.org