Mercurial > dive4elements > gnv-client
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 808:2e951160c43d | 809:d05b17a4f3d0 |
|---|---|
| 1 package de.intevation.gnv.state.describedata; | 1 package de.intevation.gnv.state.describedata; |
| 2 | 2 |
| 3 import java.util.Collection; | 3 import java.util.Collection; |
| 4 | 4 |
| 5 /** | 5 /** |
| 6 * This interface describes some methods to retrieve the name of this <code> | |
| 7 * Collection</code> and to determine if this <code>Collection</code> is a | |
| 8 * single or multiselect object. | |
| 9 * | |
| 10 * @param <E> The objects in this class need to be of this type. | |
| 6 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | 11 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
| 7 * | 12 * |
| 8 */ | 13 */ |
| 9 public interface NamedCollection<E> extends Collection<E> { | 14 public interface NamedCollection<E> extends Collection<E> { |
| 10 | 15 |
| 16 /** | |
| 17 * Returns the name of this <code>Collection</code>. | |
| 18 * | |
| 19 * @return the name. | |
| 20 */ | |
| 11 public String getName(); | 21 public String getName(); |
| 12 | 22 |
| 23 /** | |
| 24 * Determines if this <code>Collection</code> is a multi select object. | |
| 25 * | |
| 26 * @return true, if it is multi select, otherwise false. | |
| 27 */ | |
| 13 public boolean isMultiSelect(); | 28 public boolean isMultiSelect(); |
| 14 | 29 |
| 30 /** | |
| 31 * Change between single and multiselect. | |
| 32 * | |
| 33 * @param multiSelect true, if this object should be a multiselect, | |
| 34 * otherwise false. | |
| 35 */ | |
| 15 public void setMultiSelect(boolean multiSelect); | 36 public void setMultiSelect(boolean multiSelect); |
| 16 } | 37 } |
| 38 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |