Overview  Package   Class  Use  Deprecated  Index
Home >> All >> jpl2 >> [ common overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

jpl2.common
Class Preference  

java.lang.Object
  jpl2.common.Preference

---

public class Preference

extends java.lang.Object

A simple preference class, that stores preferences in a file in "user.home". This file will only be written if a preference is actually set and will only contain actually set preferences. See java.util.Properties for a description of the file format.

---

Nested Class Summary
static interface	Preference.Listener           Listener interface.

 

Field Summary
private  java.lang.String	description
private  java.util.Vector	listeners
private  java.util.Properties	prefs
private  java.io.File	prefsFile

 

Constructor Summary

Preference(java.lang.String prefsName, java.lang.String description)           Make a preference object, that stores prefs in a prefsName, with a description stored in the file.

 

Method Summary
void	addPreferenceListener(Preference.Listener l)           Add a preference listener.
void	deletePreference(java.lang.String key)
boolean	getPreference(java.lang.String key, boolean defaultValue)           Get a preference as boolean.
int	getPreference(java.lang.String key, int defaultValue)           Get a preference as an integer.
long	getPreference(java.lang.String key, long defaultValue)           Get a preference as a long.
java.lang.String	getPreference(java.lang.String key, java.lang.String defaultValue)           Get a preference, or return defaultValue if it was not specified.
java.util.Enumeration	getPreferenceKeys()
protected  void	preferenceChanged(java.lang.String pref, java.lang.String value)           Tell all of the Preference.Listener objects that a preference has changed value.
void	removePreferenceListener(Preference.Listener l)           Remove a preference listener.
private  void	savePrefs()           Attempt to save the prefs to file.
void	setPreference(java.lang.String key, boolean value)           Set a preference as a boolean.
void	setPreference(java.lang.String key, int value)           Set a preference as an integer.
void	setPreference(java.lang.String key, long value)           Set a preference as a long.
void	setPreference(java.lang.String key, java.lang.String value)           Set a preference and attempt to write it to file too.

 

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

prefs

private java.util.Properties prefs

---

prefsFile

private java.io.File prefsFile

---

description

private java.lang.String description

---

listeners

private java.util.Vector listeners

Constructor Detail

Preference

public Preference(java.lang.String prefsName,
                  java.lang.String description)

Make a preference object, that stores prefs in a prefsName, with a description stored in the file.

Method Detail

savePrefs

private void savePrefs()

Attempt to save the prefs to file.

---

getPreference

public java.lang.String getPreference(java.lang.String key,
                                      java.lang.String defaultValue)

Get a preference, or return defaultValue if it was not specified.

---

setPreference

public void setPreference(java.lang.String key,
                          java.lang.String value)

Set a preference and attempt to write it to file too.

---

setPreference

public void setPreference(java.lang.String key,
                          int value)

Set a preference as an integer.

---

setPreference

public void setPreference(java.lang.String key,
                          long value)

Set a preference as a long.

---

setPreference

public void setPreference(java.lang.String key,
                          boolean value)

Set a preference as a boolean.

---

getPreference

public int getPreference(java.lang.String key,
                         int defaultValue)

Get a preference as an integer.

---

getPreference

public long getPreference(java.lang.String key,
                          long defaultValue)

Get a preference as a long.

---

getPreference

public boolean getPreference(java.lang.String key,
                             boolean defaultValue)

Get a preference as boolean.

---

deletePreference

public void deletePreference(java.lang.String key)

---

getPreferenceKeys

public java.util.Enumeration getPreferenceKeys()

---

preferenceChanged

protected void preferenceChanged(java.lang.String pref,
                                 java.lang.String value)

Tell all of the Preference.Listener objects that a preference has changed value.

---

addPreferenceListener

public void addPreferenceListener(Preference.Listener l)

Add a preference listener.

---

removePreferenceListener

public void removePreferenceListener(Preference.Listener l)

Remove a preference listener.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> jpl2 >> [ common overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---