src/java/isac/util/usersettings/UserSettings.java
author wneuper
Wed, 15 Jun 2005 18:31:02 +0200
branchjava_rename_format
changeset 3922 fcd5648113ca
permissions -rw-r--r--
java: isac.util.tactics .. end renamed, formatted, inst_var_, import cleaned
wneuper@3922
     1
/*
wneuper@3922
     2
 * Created on Feb 22, 2005
wneuper@3922
     3
 *
wneuper@3922
     4
 * @author Alan Krempler
wneuper@3922
     5
 */
wneuper@3922
     6
wneuper@3922
     7
package isac.util.usersettings;
wneuper@3922
     8
wneuper@3922
     9
import java.io.Serializable;
wneuper@3922
    10
import java.util.HashMap;
wneuper@3922
    11
wneuper@3922
    12
/**
wneuper@3922
    13
 * Class for storing/retrieving user settings, i.e. settings which can be set
wneuper@3922
    14
 * manually by the user as opposed to the
wneuper@3922
    15
 * {@link isac.util.usersettings.UserModel#}, which is an abstraction of the
wneuper@3922
    16
 * system's expeience with a user and canot be altered manually. As there is no
wneuper@3922
    17
 * fixed set of user settings, you can regard this class as a simple storage
wneuper@3922
    18
 * backend for key/value pairs.
wneuper@3922
    19
 * 
wneuper@3922
    20
 * @author Alan Krempler
wneuper@3922
    21
 *  
wneuper@3922
    22
 */
wneuper@3922
    23
public class UserSettings implements Serializable {
wneuper@3922
    24
wneuper@3922
    25
    private HashMap storage_;
wneuper@3922
    26
wneuper@3922
    27
    UserSettings() {
wneuper@3922
    28
        storage_ = new HashMap();
wneuper@3922
    29
    }
wneuper@3922
    30
wneuper@3922
    31
    /**
wneuper@3922
    32
     * @param key
wneuper@3922
    33
     *            A string key
wneuper@3922
    34
     * @return The string value associated with the key parameter; null, if
wneuper@3922
    35
     *         nothing is stored under this key
wneuper@3922
    36
     */
wneuper@3922
    37
    public String getValue(String key) {
wneuper@3922
    38
        return (String) storage_.get(key);
wneuper@3922
    39
    }
wneuper@3922
    40
wneuper@3922
    41
    /**
wneuper@3922
    42
     * @param key
wneuper@3922
    43
     *            The key under which "value" is to be stored. Existing data
wneuper@3922
    44
     *            unde the same key will be replaced.
wneuper@3922
    45
     * @param value
wneuper@3922
    46
     *            The value to be stored under "key"
wneuper@3922
    47
     * @return true in case of success, false in case of error, for example if
wneuper@3922
    48
     *         trying to replace stored values without proper permissions
wneuper@3922
    49
     */
wneuper@3922
    50
    public boolean setValue(String key, String value) {
wneuper@3922
    51
        storage_.put(key, value);
wneuper@3922
    52
        return true;
wneuper@3922
    53
    }
wneuper@3922
    54
wneuper@3922
    55
}