diff gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/NamedArrayList.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/NamedArrayList.java	Thu Apr 08 16:35:02 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/NamedArrayList.java	Fri Apr 09 07:27:38 2010 +0000
@@ -4,8 +4,10 @@
 import java.util.Collection;
 
 /**
+ * This is the default implementation of <code>NamedCollection</code>.
+ *
+ * @param <E> The type which the objects stored in this object are from.
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
- *
  */
 public class NamedArrayList<E> extends ArrayList<E> implements
                                                    NamedCollection<E> {
@@ -20,6 +22,8 @@
 
     /**
      * Constructor
+     *
+     * @param name The name of this collection.
      */
     public NamedArrayList(String name) {
         this.name = name;
@@ -28,7 +32,8 @@
     /**
      * Constructor
      *
-     * @param initialCapacity
+     * @param name The name of this collection.
+     * @param initialCapacity The initial capacity of this collection.
      */
     public NamedArrayList(String name, int initialCapacity) {
         super(initialCapacity);
@@ -38,31 +43,24 @@
     /**
      * Constructor
      *
-     * @param c
+     * @param name The name of this collection.
+     * @param c the collection whose elements are to be placed into this list.
      */
     public NamedArrayList(String name, Collection<E> c) {
         super(c);
         this.name = name;
     }
 
-    /**
-     * @see de.intevation.gnv.state.describedata.NamedCollection#getName()
-     */
     public String getName() {
         return this.name;
     }
 
-    /**
-     * @see de.intevation.gnv.state.describedata.NamedCollection#isMultiSelect()
-     */
     public boolean isMultiSelect() {
         return multiSelect;
     }
 
-    /**
-     * @see de.intevation.gnv.state.describedata.NamedCollection#setMultiSelect(boolean)
-     */
     public void setMultiSelect(boolean multiSelect) {
         this.multiSelect = multiSelect;
     }
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
\ No newline at end of file

http://dive4elements.wald.intevation.org