Mercurial > dive4elements > gnv-client

annotate gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/SingleValueDescribeData.java @ 845:797a6264b89b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Integrated the CacheCleaner for the ThematicDataCache gnv-artifacts/trunk@961 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Tue, 20 Apr 2010 18:38:22 +0000
parents 05bf8534a35a
children f953c9a559d8
rev   line source
335
e964a3d8f7bc Some Refactoring work done.
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
1 package de.intevation.gnv.state.describedata;
e964a3d8f7bc Some Refactoring work done.
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
2
e964a3d8f7bc Some Refactoring work done.
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
3 /**
809
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
4 * This interface defines some methods to store and retrieve key-value pairs.
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
5 *
780
c4156275c1e1 Bring @author javadoc tags in form '@author <a href="john.doe@example.com">John Doe</a>'
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 779
diff changeset
6 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
335
e964a3d8f7bc Some Refactoring work done.
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
7 */
e964a3d8f7bc Some Refactoring work done.
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
8 public interface SingleValueDescribeData extends DescribeData {
e964a3d8f7bc Some Refactoring work done.
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
9
809
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
10 /**
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
11 * Returns the name of this object.
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
12 *
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
13 * @return the name.
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
14 */
335
e964a3d8f7bc Some Refactoring work done.
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
15 public String getName();
e964a3d8f7bc Some Refactoring work done.
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
16
809
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
17 /**
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
18 * Returns the value stored in this object.
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
19 *
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
20 * @return the value.
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
21 */
335
e964a3d8f7bc Some Refactoring work done.
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
22 public String getValue();
778
9a828e5a2390 Removed trailing whitespace
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 473
diff changeset
23
809
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
24 /**
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
25 * Sets the value of this object to <i>value</i>.
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
26 *
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
27 * @param value A new value.
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
28 */
335
e964a3d8f7bc Some Refactoring work done.
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
29 public void setValue(String value);
473
a6a33ef35809 Added support to step back to previous states. Add state names to xform nodes in describe document and append old targets to list of reachable targets.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 335
diff changeset
30
809
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
31 /**
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
32 * Returns the state this objects belongs to.
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
33 *
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
34 * @return the state.
d05b17a4f3d0 Added javadoc in describedata package.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 780
diff changeset
35 */
473
a6a33ef35809 Added support to step back to previous states. Add state names to xform nodes in describe document and append old targets to list of reachable targets.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents: 335
diff changeset
36 public String getState();
335
e964a3d8f7bc Some Refactoring work done.
Tim Englich <tim.englich@intevation.de>
parents:
diff changeset
37 }
836
05bf8534a35a Using unix line endings only.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents: 809
diff changeset
38 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :
http://dive4elements.wald.intevation.org