Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/MinMaxDescribeData.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 |
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 describes some methods to set and retrieve a min-max value | |
5 * pair with a specific name. | |
6 * | |
4 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | 7 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
5 * | |
6 */ | 8 */ |
7 public interface MinMaxDescribeData extends DescribeData { | 9 public interface MinMaxDescribeData extends DescribeData { |
8 | 10 |
11 /** | |
12 * Returns the min value stored in this object. | |
13 * | |
14 * @return the min value. | |
15 */ | |
9 public Object getMinValue(); | 16 public Object getMinValue(); |
10 | 17 |
18 /** | |
19 * Returns the max value stored in this object. | |
20 * | |
21 * @return the max value. | |
22 */ | |
11 public Object getMaxValue(); | 23 public Object getMaxValue(); |
12 | 24 |
25 /** | |
26 * Sets the min value in this object. | |
27 * | |
28 * @param minValue A new min value. | |
29 */ | |
13 public void setMinValue(Object minValue); | 30 public void setMinValue(Object minValue); |
14 | 31 |
32 /** | |
33 * Sets the max value in this object. | |
34 * | |
35 * @param maxValue A new max value. | |
36 */ | |
15 public void setMaxValue(Object maxValue); | 37 public void setMaxValue(Object maxValue); |
16 | 38 |
39 /** | |
40 * Returns the general name of this object. | |
41 * | |
42 * @return the name. | |
43 */ | |
17 public String getName(); | 44 public String getName(); |
18 | 45 |
46 /** | |
47 * Returns the name of the min value. | |
48 * | |
49 * @return the name of the min value. | |
50 */ | |
19 public String getMinName(); | 51 public String getMinName(); |
20 | 52 |
53 /** | |
54 * Returns the name of this max value. | |
55 * | |
56 * @return the name of the max value. | |
57 */ | |
21 public String getMaxName(); | 58 public String getMaxName(); |
22 | 59 |
60 /** | |
61 * Returns the state this object belongs to. | |
62 * | |
63 * @return the state. | |
64 */ | |
23 public String getState(); | 65 public String getState(); |
24 } | 66 } |
67 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |