diff gnv-artifacts/src/main/java/de/intevation/gnv/state/DefaultInputValue.java @ 796:a5526908f92f

Added javadoc in state package. gnv-artifacts/trunk@878 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Thu, 01 Apr 2010 09:15:36 +0000
parents c4156275c1e1
children feae2f9d6c6f
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/DefaultInputValue.java	Wed Mar 31 13:48:07 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/DefaultInputValue.java	Thu Apr 01 09:15:36 2010 +0000
@@ -1,8 +1,10 @@
 package de.intevation.gnv.state;
 
 /**
+ * The default implementation of <code>InputValue</code>. InputValue objects are
+ * used to store meta information about <code>InputData</code> objects.
+ * 
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
- *
  */
 public class DefaultInputValue implements InputValue {
 
@@ -16,6 +18,13 @@
     private int usedInQueries = 1;
     private String defaultValue = "N/N";
 
+    /**
+     *
+     * @param name
+     * @param type
+     * @param defaultValue
+     * @param multiselect
+     */
     public DefaultInputValue(String name, String type, String defaultValue,
                              boolean multiselect) {
         this(name, type, multiselect, 1);
@@ -25,6 +34,10 @@
 
     /**
      * Constructor
+     * @param name
+     * @param type
+     * @param multiselect
+     * @param usedInQueries
      */
     public DefaultInputValue(String name, String type, boolean multiselect,
                              int usedInQueries) {
@@ -35,21 +48,23 @@
     }
 
     /**
-     * @see de.intevation.gnv.state.InputValue#getName()
+     * @return
      */
     public String getName() {
         return this.name;
     }
 
     /**
-     * @see de.intevation.gnv.state.InputValue#getType()
+     * @return
      */
     public String getType() {
         return this.type;
     }
 
     /**
-     * @see java.lang.Object#toString()
+     * Returns the information as string.
+     * 
+     * @return information as string.
      */
     @Override
     public String toString() {
@@ -58,18 +73,27 @@
     }
 
     /**
-     * @see de.intevation.gnv.state.InputValue#isMultiselect()
+     * @return
      */
     public boolean isMultiselect() {
         return this.multiselect;
     }
 
+    /**
+     *
+     * @return
+     */
     public int usedInQueries() {
         return this.usedInQueries;
     }
 
+    /**
+     *
+     * @return
+     */
     public String getDefaultValue() {
         return this.defaultValue;
     }
 
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :
\ No newline at end of file

http://dive4elements.wald.intevation.org