Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/SingleValueDescribeData.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 /** | 3 /** |
| 4 * This interface defines some methods to store and retrieve key-value pairs. | |
| 5 * | |
| 4 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | 6 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
| 5 * | |
| 6 */ | 7 */ |
| 7 public interface SingleValueDescribeData extends DescribeData { | 8 public interface SingleValueDescribeData extends DescribeData { |
| 8 | 9 |
| 10 /** | |
| 11 * Returns the name of this object. | |
| 12 * | |
| 13 * @return the name. | |
| 14 */ | |
| 9 public String getName(); | 15 public String getName(); |
| 10 | 16 |
| 17 /** | |
| 18 * Returns the value stored in this object. | |
| 19 * | |
| 20 * @return the value. | |
| 21 */ | |
| 11 public String getValue(); | 22 public String getValue(); |
| 12 | 23 |
| 24 /** | |
| 25 * Sets the value of this object to <i>value</i>. | |
| 26 * | |
| 27 * @param value A new value. | |
| 28 */ | |
| 13 public void setValue(String value); | 29 public void setValue(String value); |
| 14 | 30 |
| 31 /** | |
| 32 * Returns the state this objects belongs to. | |
| 33 * | |
| 34 * @return the state. | |
| 35 */ | |
| 15 public String getState(); | 36 public String getState(); |
| 16 } | 37 } |
| 38 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |