view 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
line wrap: on
line source
package de.intevation.gnv.state.describedata;

/**
 * This interface defines some methods to store and retrieve key-value pairs.
 *
 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
 */
public interface SingleValueDescribeData extends DescribeData {

    /**
     * Returns the name of this object.
     *
     * @return the name.
     */
    public String getName();

    /**
     * Returns the value stored in this object.
     *
     * @return the value.
     */
    public String getValue();

    /**
     * Sets the value of this object to <i>value</i>.
     *
     * @param value A new value.
     */
    public void setValue(String value);

    /**
     * Returns the state this objects belongs to.
     *
     * @return the state.
     */
    public String getState();
}
// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org