jhelp.util.preference

Class Preferences

java.lang.Object

jhelp.util.preference.Preferences

public class Preferences
extends java.lang.Object

Store preferences in RAM and file.
A preference have a name, type and value.
Actual preferences type are describe in PreferenceType
The preferences file may not exists on first use, it will be created automatically when save is need

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.HashMap<java.lang.String,Pair<PreferenceType,java.lang.Object>>	preferences Preferences map
private java.io.File	preferencesFile File where store preferences
private PreferencesSerializer	preferencesSerializer Preferences serializer to save them

Constructor Summary

Constructors

Constructor and Description
Preferences(java.io.File preferencesFile) Create a new instance of Preferences

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getArrayValue(java.lang.String name) Get a byte[] from preferences
java.io.File	getFileValue(java.lang.String name) Get file from preferences
PreferenceType	getPreferenceType(java.lang.String name) Obtain the type of a preference
boolean	getValue(java.lang.String name, boolean defaultValue) Get a boolean value from preferences
int	getValue(java.lang.String name, int defaultValue) Get a int value from preferences
java.lang.String	getValue(java.lang.String name, java.lang.String defaultValue) Get a String value from preferences
private void	loadPreferences() Load preferences
(package private) static java.lang.Object	parse(java.lang.String serializedValue, PreferenceType preferenceType) Parse a serialized value to the real value depends on PreferenceType
private void	savePreferences() Save preferences
(package private) static java.lang.String	serialize(java.lang.Object value, PreferenceType preferenceType) Serialize a value depends on PreferenceType
void	setValue(java.lang.String name, boolean value) Define/change a boolean value
void	setValue(java.lang.String name, byte[] value) Define/change a byte[] value
void	setValue(java.lang.String name, java.io.File value) Define/change a File value
void	setValue(java.lang.String name, int value) Define/change a int value
void	setValue(java.lang.String name, java.lang.String value) Define/change a String value

Methods inherited from class java.lang.Object

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

Field Detail

preferences

private final java.util.HashMap<java.lang.String,Pair<PreferenceType,java.lang.Object>> preferences

Preferences map

preferencesFile

private final java.io.File preferencesFile

File where store preferences

preferencesSerializer

private final PreferencesSerializer preferencesSerializer

Preferences serializer to save them

Constructor Detail

Preferences

public Preferences(java.io.File preferencesFile)

Create a new instance of Preferences

Parameters:

preferencesFile - File where read/write preferences may not actually exists

Method Detail

parse

static java.lang.Object parse(java.lang.String serializedValue,
                     PreferenceType preferenceType)

Parse a serialized value to the real value depends on PreferenceType

Parameters:

serializedValue - Serialized value

preferenceType - Preference type

Returns:

Parsed value

serialize

static java.lang.String serialize(java.lang.Object value,
                         PreferenceType preferenceType)

Serialize a value depends on PreferenceType

Parameters:

value - Value to serialize

preferenceType - Preference type

Returns:

Serialized value

loadPreferences

private void loadPreferences()

Load preferences

savePreferences

private void savePreferences()

Save preferences

getArrayValue

public byte[] getArrayValue(java.lang.String name)

Get a byte[] from preferences

Parameters:

name - Preference name

Returns:

Array in preference or null if not exists

getFileValue

public java.io.File getFileValue(java.lang.String name)

Get file from preferences

Parameters:

name - preference name

Returns:

File in preferences or null if not exists

getPreferenceType

public PreferenceType getPreferenceType(java.lang.String name)

Obtain the type of a preference

Parameters:

name - Preference name

Returns:

Preference type or null if preference dosen't exists

getValue

public boolean getValue(java.lang.String name,
               boolean defaultValue)

Get a boolean value from preferences

Parameters:

name - Preference name

defaultValue - Value to store and return if preference not already exists

Returns:

Preference value or default value

getValue

public int getValue(java.lang.String name,
           int defaultValue)

Get a int value from preferences

Parameters:

name - Preference name

defaultValue - Value to store and return if preference not already exists

Returns:

Preference value or default value

getValue

public java.lang.String getValue(java.lang.String name,
                        java.lang.String defaultValue)

Get a String value from preferences

Parameters:

name - Preference name

defaultValue - Value to store and return if preference not already exists

Returns:

Preference value or default value

setValue

public void setValue(java.lang.String name,
            boolean value)

Define/change a boolean value

Parameters:

name - Preference name

value - New value

setValue

public void setValue(java.lang.String name,
            byte[] value)

Define/change a byte[] value

Parameters:

name - Preference name

value - New value

setValue

public void setValue(java.lang.String name,
            java.io.File value)

Define/change a File value

Parameters:

name - Preference name

value - New value

setValue

public void setValue(java.lang.String name,
            int value)

Define/change a int value

Parameters:

name - Preference name

value - New value

setValue

public void setValue(java.lang.String name,
            java.lang.String value)

Define/change a String value

Parameters:

name - Preference name

value - New value