Mercurial > dive4elements > gnv-client

comparison gnv-artifacts/src/main/java/de/intevation/gnv/state/InputData.java @ 796:a5526908f92f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added javadoc in state package. gnv-artifacts/trunk@878 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Thu, 01 Apr 2010 09:15:36 +0000
parents c4156275c1e1
children feae2f9d6c6f
comparison
equal deleted inserted replaced
795:cdade5005cba 796:a5526908f92f
1 package de.intevation.gnv.state; 1 package de.intevation.gnv.state;
2 2
3 import java.io.Serializable; 3 import java.io.Serializable;
4 4
5 /** 5 /**
6 * This interface defines the basic methods used to store multiple values with
7 * a specific key and name.
8 *
6 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> 9 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
7 * 10 *
8 */ 11 */
9 public interface InputData extends Serializable { 12 public interface InputData extends Serializable {
10 13
14 /**
15 * Method to Retrieve the name of this input data item.
16 *
17 * @return the name
18 */
11 public String getName(); 19 public String getName();
12 20
21 /**
22 * Method to retrieve the value of this input data item. A value might be a
23 * list of values separated by a specific character.
24 *
25 * @return the value
26 */
13 public String getValue(); 27 public String getValue();
14 28
29 /**
30 * Method to store a further object at this input data item.
31 *
32 * @param o A further object.
33 */
15 public void setObject(Object o); 34 public void setObject(Object o);
16 35
36 /**
37 * Method to retrieve the extra object.
38 *
39 * @return the extra object.
40 */
17 public Object getObject(); 41 public Object getObject();
18 42
43 /**
44 * Method to store descriptions for this input data item.
45 *
46 * @param description Array of descriptions.
47 */
19 public void setDescription(String[] description); 48 public void setDescription(String[] description);
20 49
50 /**
51 * Method to retrieve a description specified by a given key.
52 *
53 * @param key Key.
54 * @return the description for this key.
55 */
21 public String getDescription(String key); 56 public String getDescription(String key);
22 57
58 /**
59 * Method to retrieve all descriptions of this input data item.
60 *
61 * @return descriptions.
62 */
23 public String[] getDescription(); 63 public String[] getDescription();
24 64
65 /**
66 * Append a further string value to the value field devided by a separater
67 * character.
68 *
69 * @param value Value to append.
70 */
25 public void concartValue(String value); 71 public void concartValue(String value);
26 72
73 /**
74 * Method to retrieve the character separated values split into an array.
75 *
76 * @return
77 */
27 String[] splitValue(); 78 String[] splitValue();
28 } 79 }
80 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :
http://dive4elements.wald.intevation.org