diff gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/NamedCollection.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/NamedCollection.java	Thu Apr 08 16:35:02 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/NamedCollection.java	Fri Apr 09 07:27:38 2010 +0000
@@ -3,14 +3,36 @@
 import java.util.Collection;
 
 /**
+ * This interface describes some methods to retrieve the name of this <code>
+ * Collection</code> and to determine if this <code>Collection</code> is a
+ * single or multiselect object.
+ *
+ * @param <E> The objects in this class need to be of this type.
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  *
  */
 public interface NamedCollection<E> extends Collection<E> {
 
+    /**
+     * Returns the name of this <code>Collection</code>.
+     *
+     * @return the name.
+     */
     public String getName();
 
+    /**
+     * Determines if this <code>Collection</code> is a multi select object.
+     *
+     * @return true, if it is multi select, otherwise false.
+     */
     public boolean isMultiSelect();
 
+    /**
+     * Change between single and multiselect.
+     *
+     * @param multiSelect true, if this object should be a multiselect,
+     * otherwise false.
+     */
     public void setMultiSelect(boolean 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