pivot.util
Class Preferences

java.lang.Object
  extended by pivot.util.Preferences
All Implemented Interfaces:
java.lang.Iterable<java.lang.String>, Dictionary<java.lang.String,java.lang.Object>

public class Preferences
extends java.lang.Object
implements Dictionary<java.lang.String,java.lang.Object>, java.lang.Iterable<java.lang.String>

Provides access to application preference data. Preferences are modeled as JSON data and are stored using the JNLP Persistence API. One top-level JSON object exists per URL. The dictionary methods allow a caller to access and modify this data.

Keys may be dot-delimited, allowing callers to get/set nested values.

Author:
gbrown

Constructor Summary
Preferences(java.net.URL url, Dictionary<java.lang.String,java.lang.Object> defaults)
          Creates a preferences object that provides access to the preferences for a given URL.
 
Method Summary
 boolean containsKey(java.lang.String key)
          Tests the existence of a key in the dictionary.
 java.lang.Object get(java.lang.String key)
          Retrieves the value for the given key.
 ListenerList<PreferencesListener> getPreferencesListeners()
           
 boolean isEmpty()
          Tests the emptiness of the dictionary.
 java.util.Iterator<java.lang.String> iterator()
           
 java.lang.Object put(java.lang.String key, java.lang.Object value)
          Sets the value of the given key, creating a new entry or replacing the existing value.
 java.lang.Object remove(java.lang.String key)
          Removes a key/value pair from the map.
 void save()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Preferences

public Preferences(java.net.URL url,
                   Dictionary<java.lang.String,java.lang.Object> defaults)
            throws java.io.IOException,
                   SerializationException
Creates a preferences object that provides access to the preferences for a given URL.

Parameters:
url -
defaults -
Throws:
java.io.IOException
SerializationException
Method Detail

get

public java.lang.Object get(java.lang.String key)
Description copied from interface: Dictionary
Retrieves the value for the given key.

Specified by:
get in interface Dictionary<java.lang.String,java.lang.Object>
Parameters:
key - The key whose value is to be returned.
Returns:
The value corresponding to key, or null if the key does not exist. Will also return null if the key refers to a null value. Use containsKey() to distinguish between these two cases.

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)
Description copied from interface: Dictionary
Sets the value of the given key, creating a new entry or replacing the existing value.

Specified by:
put in interface Dictionary<java.lang.String,java.lang.Object>
Parameters:
key - The key whose value is to be set.
value - The value to be associated with the given key.

remove

public java.lang.Object remove(java.lang.String key)
Description copied from interface: Dictionary
Removes a key/value pair from the map.

Specified by:
remove in interface Dictionary<java.lang.String,java.lang.Object>
Parameters:
key - The key whose mapping is to be removed.
Returns:
The value that was removed.

containsKey

public boolean containsKey(java.lang.String key)
Description copied from interface: Dictionary
Tests the existence of a key in the dictionary.

Specified by:
containsKey in interface Dictionary<java.lang.String,java.lang.Object>
Parameters:
key - The key whose presence in the dictionary is to be tested.
Returns:
true if the key exists in the dictionary; false, otherwise.

isEmpty

public boolean isEmpty()
Description copied from interface: Dictionary
Tests the emptiness of the dictionary.

Specified by:
isEmpty in interface Dictionary<java.lang.String,java.lang.Object>
Returns:
true if the dictionary contains no keys; false, otherwise.

save

public void save()
          throws java.io.IOException,
                 SerializationException
Throws:
java.io.IOException
SerializationException

iterator

public java.util.Iterator<java.lang.String> iterator()
Specified by:
iterator in interface java.lang.Iterable<java.lang.String>

getPreferencesListeners

public ListenerList<PreferencesListener> getPreferencesListeners()