Mercurial > dive4elements > gnv-client
diff gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/DefaultKeyValueDescribeData.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 | 2423cefe7d39 |
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/DefaultKeyValueDescribeData.java Thu Apr 08 16:35:02 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/DefaultKeyValueDescribeData.java Fri Apr 09 07:27:38 2010 +0000 @@ -1,14 +1,13 @@ package de.intevation.gnv.state.describedata; /** + * This is the default implementation of <code>KeyValueDescibeData</code>. This + * class just implements the necessary methods and two constructors. + * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> - * */ public class DefaultKeyValueDescribeData implements KeyValueDescibeData { - /** - * - */ private static final long serialVersionUID = -924469415242703108L; private String key; @@ -19,10 +18,25 @@ private boolean selected = false; + /** + * Creates a new instance of this class with a key-value pair, but no state + * and no selection. + * + * @param key The key. + * @param value A value. + */ public DefaultKeyValueDescribeData(String key, String value) { this(key, value, null); } + /** + * Creates a new instance of this class with a key-value pair and the state + * this object belongs to. + * + * @param key The key. + * @param value A value. + * @param state A state. + */ public DefaultKeyValueDescribeData(String key, String value, String state) { super(); this.key = key; @@ -30,37 +44,24 @@ this.state = state; } - /** - * @see de.intevation.gnv.state.describedata.KeyValueDescibeData#getKey() - */ public String getKey() { return this.key; } - /** - * @see de.intevation.gnv.state.describedata.KeyValueDescibeData#getValue() - */ public String getValue() { return this.value; } - /** - * @see de.intevation.gnv.state.describedata.KeyValueDescibeData#isSelected() - */ public boolean isSelected() { return this.selected; } - /** - * @see de.intevation.gnv.state.describedata.KeyValueDescibeData#setSelected(boolean) - */ public void setSelected(boolean selected) { this.selected = selected; } - public String getState() { return this.state; } - } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file