public class FHAESPreferences
extends java.lang.Object
The FHAESPreference system enables us to save and retrieve values across sessions. The values are stored in locations specific to the host operating system. For instance in Windows they are stored in the registry and in Linux they are stored in a system file in the users home.
Preferences should be accessed and set through a static variable e.g. App.prefs. There are a variety of setter functions depending on the data type trying to be stored e.g. setIntPref() setDoublePref() but they all follow the same style taking a PrefKey and a value. The PrefKey is an enumeration listed in this class containing the key names that are stored in the users preferences file/registry.
Similarly there are accessor methods depending on the data type being extracted e.g. getIntPref() getDoublePref(). These all require a PrefKey and a default value to be returned when no value is found.
Modifier and Type | Class and Description |
---|---|
static class |
FHAESPreferences.PrefKey
This enum contains the keys for the preference values stored and used by FHAES.
|
Modifier and Type | Field and Description |
---|---|
private static java.lang.String |
ARRAY_DELIMITER |
private java.util.ArrayList<PrefsListener> |
listeners |
private static org.slf4j.Logger |
log |
private static java.util.prefs.Preferences |
prefs |
private java.lang.Boolean |
silentMode |
Constructor and Description |
---|
FHAESPreferences() |
Modifier and Type | Method and Description |
---|---|
void |
addPrefsListener(PrefsListener l)
Add a listener for changes to preferences.
|
void |
addStringtoPrefArray(FHAESPreferences.PrefKey key,
java.lang.String str,
java.lang.Integer maxSize)
Add a string to a preference array.
|
void |
clearPref(FHAESPreferences.PrefKey key)
Remove a preference value.
|
void |
firePrefChanged(FHAESPreferences.PrefKey pref)
Fire a preference change event for a specific PrefKey.
|
AnalysisLabelType |
getAnalysisLabelTypePref(FHAESPreferences.PrefKey key,
AnalysisLabelType defaultValue)
Get the value of a AnalysisLabelType preference.
|
AnalysisType |
getAnalysisTypePref(FHAESPreferences.PrefKey key,
AnalysisType defaultValue)
Get the value of an AnalysisType preference.
|
java.util.ArrayList<java.lang.String> |
getArrayListPref(FHAESPreferences.PrefKey key,
java.util.ArrayList<java.lang.String> defaultValue)
TODO
|
java.lang.Boolean |
getBooleanPref(FHAESPreferences.PrefKey key,
java.lang.Boolean defaultValue)
Method for getting the boolean value of a preference.
|
java.awt.Color |
getColorPref(FHAESPreferences.PrefKey key,
java.awt.Color defaultValue)
Get a color for the specified preference key.
|
java.lang.Double |
getDoublePref(FHAESPreferences.PrefKey key,
java.lang.Double defaultValue)
Get the specified preference as an Double.
|
EventTypeToProcess |
getEventTypePref(FHAESPreferences.PrefKey key,
EventTypeToProcess defaultValue)
Get the value of a EventTypeToProcess preference.
|
FireFilterType |
getFireFilterTypePref(FHAESPreferences.PrefKey key,
FireFilterType defaultValue)
Get the value of an FireFilterType preference.
|
java.util.ArrayList<java.lang.Integer> |
getIntegerArrayPref(FHAESPreferences.PrefKey key,
java.util.ArrayList<java.lang.Integer> defaultValue)
TODO
|
int |
getIntPref(FHAESPreferences.PrefKey key,
int defaultValue)
Get the specified preference as an int.
|
LabelOrientation |
getLabelOrientationPref(FHAESPreferences.PrefKey key,
LabelOrientation defaultValue)
Get the value of a LabelAlignment preference.
|
LineStyle |
getLineStylePref(FHAESPreferences.PrefKey key,
LineStyle defaultValue)
TODO
|
NoDataLabel |
getNoDataLabelPref(FHAESPreferences.PrefKey key,
NoDataLabel defaultValue)
TODO
|
java.lang.String |
getPref(FHAESPreferences.PrefKey key,
java.lang.String defaultValue)
Method for getting the string value of a preference.
|
ResamplingType |
getResamplingTypePref(FHAESPreferences.PrefKey key,
ResamplingType defaultValue)
Get the value of a AnalysisLabelType preference.
|
java.util.LinkedList<java.lang.String> |
getStringArrayPref(FHAESPreferences.PrefKey key)
Get a preference as a ArrayList.
|
boolean |
isSilentMode()
Whether the silentMode is on.
|
static void |
removePref(FHAESPreferences.PrefKey key)
Remove a preference value.
|
void |
removePrefsListener(PrefsListener l)
Remove a listener when you no longer what to hear about changes to preferences.
|
void |
removeStringFromPrefArray(FHAESPreferences.PrefKey key,
java.lang.String str)
Remove a string from a preference array.
|
void |
setAnalysisLabelTypePref(FHAESPreferences.PrefKey key,
AnalysisLabelType value)
Set the value of a preference to the specified AnalysisLabelType.
|
void |
setAnalysisTypePref(FHAESPreferences.PrefKey key,
AnalysisType value)
Set the value of a preference to the specified AnalysisType.
|
void |
setArrayListPref(FHAESPreferences.PrefKey key,
java.util.ArrayList<java.lang.String> values)
Set the value of a preference.
|
void |
setBooleanPref(FHAESPreferences.PrefKey key,
boolean value)
Set the value of a preference to the specified boolean.
|
void |
setColorPref(FHAESPreferences.PrefKey pref,
java.awt.Color value)
Set the value of a preference to the specified color.
|
void |
setDoublePref(FHAESPreferences.PrefKey pref,
java.lang.Double value)
Set the value of a preference to the specified Double.
|
void |
setEventTypePref(FHAESPreferences.PrefKey key,
EventTypeToProcess value)
Set the value of a preference to the specified EventTypeToProcess.
|
void |
setFireFilterTypePref(FHAESPreferences.PrefKey key,
FireFilterType value)
Set the value of a preference to the specified FireFilterType.
|
void |
setIntegerArrayPref(FHAESPreferences.PrefKey key,
java.util.ArrayList<java.lang.Integer> values)
TODO
|
void |
setIntPref(FHAESPreferences.PrefKey pref,
int value)
Set the value of a preference to the specified int.
|
void |
setLabelOrientationPref(FHAESPreferences.PrefKey key,
LabelOrientation value)
TODO
|
void |
setLineStylePref(FHAESPreferences.PrefKey key,
LineStyle value)
TODO
|
void |
setNoDataLabelPref(FHAESPreferences.PrefKey key,
NoDataLabel value)
TODO
|
void |
setPref(FHAESPreferences.PrefKey key,
java.lang.String value)
Store a string preference for a given key.
|
void |
setResamplingTypePref(FHAESPreferences.PrefKey key,
ResamplingType value)
Set the value of a preference to the specified ResamplingType.
|
void |
setSilentMode(java.lang.Boolean mode)
Sets the silentMode on and off.
|
void |
setStringArrayPref(FHAESPreferences.PrefKey key,
java.util.List<java.lang.String> arr)
Store a string ArrayList preference for a given key.
|
private static java.util.prefs.Preferences prefs
private static final org.slf4j.Logger log
private static final java.lang.String ARRAY_DELIMITER
private java.lang.Boolean silentMode
private final java.util.ArrayList<PrefsListener> listeners
public void setSilentMode(java.lang.Boolean mode)
mode
- public boolean isSilentMode()
public void addPrefsListener(PrefsListener l)
l
- public void removePrefsListener(PrefsListener l)
l
- public void firePrefChanged(FHAESPreferences.PrefKey pref)
pref
- public java.lang.String getPref(FHAESPreferences.PrefKey key, java.lang.String defaultValue)
key
- defaultValue
- public java.util.ArrayList<java.lang.String> getArrayListPref(FHAESPreferences.PrefKey key, java.util.ArrayList<java.lang.String> defaultValue)
key
- defaultValue
- public java.util.ArrayList<java.lang.Integer> getIntegerArrayPref(FHAESPreferences.PrefKey key, java.util.ArrayList<java.lang.Integer> defaultValue)
key
- defaultValue
- public AnalysisType getAnalysisTypePref(FHAESPreferences.PrefKey key, AnalysisType defaultValue)
key
- defaultValue
- public void setArrayListPref(FHAESPreferences.PrefKey key, java.util.ArrayList<java.lang.String> values)
key
- values
- public void setIntegerArrayPref(FHAESPreferences.PrefKey key, java.util.ArrayList<java.lang.Integer> values)
key
- values
- public void setAnalysisTypePref(FHAESPreferences.PrefKey key, AnalysisType value)
key
- value
- public FireFilterType getFireFilterTypePref(FHAESPreferences.PrefKey key, FireFilterType defaultValue)
key
- defaultValue
- public EventTypeToProcess getEventTypePref(FHAESPreferences.PrefKey key, EventTypeToProcess defaultValue)
key
- defaultValue
- public NoDataLabel getNoDataLabelPref(FHAESPreferences.PrefKey key, NoDataLabel defaultValue)
key
- defaultValue
- public LineStyle getLineStylePref(FHAESPreferences.PrefKey key, LineStyle defaultValue)
key
- defaultValue
- public AnalysisLabelType getAnalysisLabelTypePref(FHAESPreferences.PrefKey key, AnalysisLabelType defaultValue)
key
- defaultValue
- public LabelOrientation getLabelOrientationPref(FHAESPreferences.PrefKey key, LabelOrientation defaultValue)
key
- defaultValue
- public ResamplingType getResamplingTypePref(FHAESPreferences.PrefKey key, ResamplingType defaultValue)
key
- defaultValue
- public void setColorPref(FHAESPreferences.PrefKey pref, java.awt.Color value)
pref
- value
- public void setAnalysisLabelTypePref(FHAESPreferences.PrefKey key, AnalysisLabelType value)
key
- value
- public void setLabelOrientationPref(FHAESPreferences.PrefKey key, LabelOrientation value)
key
- value
- public void setResamplingTypePref(FHAESPreferences.PrefKey key, ResamplingType value)
key
- value
- public void setFireFilterTypePref(FHAESPreferences.PrefKey key, FireFilterType value)
key
- value
- public void setEventTypePref(FHAESPreferences.PrefKey key, EventTypeToProcess value)
key
- value
- public void setNoDataLabelPref(FHAESPreferences.PrefKey key, NoDataLabel value)
key
- value
- public void setLineStylePref(FHAESPreferences.PrefKey key, LineStyle value)
key
- value
- public void setPref(FHAESPreferences.PrefKey key, java.lang.String value)
key
- value
- public void clearPref(FHAESPreferences.PrefKey key)
key
- public void setStringArrayPref(FHAESPreferences.PrefKey key, java.util.List<java.lang.String> arr)
key
- arr
- public void addStringtoPrefArray(FHAESPreferences.PrefKey key, java.lang.String str, java.lang.Integer maxSize)
key
- str
- maxSize
- public void removeStringFromPrefArray(FHAESPreferences.PrefKey key, java.lang.String str)
key
- str
- public java.util.LinkedList<java.lang.String> getStringArrayPref(FHAESPreferences.PrefKey key)
key
- public java.awt.Color getColorPref(FHAESPreferences.PrefKey key, java.awt.Color defaultValue)
key
- defaultValue
- public java.lang.Boolean getBooleanPref(FHAESPreferences.PrefKey key, java.lang.Boolean defaultValue)
key
- defaultValue
- public void setBooleanPref(FHAESPreferences.PrefKey key, boolean value)
key
- value
- public void setIntPref(FHAESPreferences.PrefKey pref, int value)
pref
- value
- public void setDoublePref(FHAESPreferences.PrefKey pref, java.lang.Double value)
pref
- value
- public int getIntPref(FHAESPreferences.PrefKey key, int defaultValue)
key
- defaultValue
- public java.lang.Double getDoublePref(FHAESPreferences.PrefKey key, java.lang.Double defaultValue)
key
- defaultValue
- public static void removePref(FHAESPreferences.PrefKey key)
key
-