org.mdiutil.prefs

Class PreferencesHelper

java.lang.Object

org.mdiutil.prefs.PreferencesHelper

Direct Known Subclasses:

PreferencesUIHelper

public class PreferencesHelper
extends Object

This class helps to put and get values to Preferences for Files, and String arrays, which are not direcly handled in the core java Preferences class.

Constructor Summary

Constructors

Constructor and Description
PreferencesHelper()

Method Summary

Modifier and Type	Method and Description
static boolean[]	getBooleanArray(Preferences prefs, String node, boolean def) Returns the boolean[] represented by the string associated with the specified node in this preference node.
static File	getFile(Preferences prefs, String key) Returns the File represented by the string associated with the specified key in this preference node.
static File	getFile(Preferences prefs, String key, File defFile) Returns the File represented by the string associated with the specified key in this preference node.
static String	getFileName(Preferences prefs, String key, String path) Returns the FileName represented by the string associated with the specified key in this preference node.
static File	getFileRelativeTo(Preferences prefs, String key, File defFile, File dir) Returns the File represented by the string associated with the specified key in this preference node.
static File[]	getFiles(Preferences prefs, String node, File[] defFiles) Returns the File[] represented by the string associated with the specified node in this preference node.
static File[]	getFilesRelativeTo(Preferences prefs, String key, File[] defFiles, File dir) Returns the File[] represented by the string associated with the specified node in this preference node.
static Map<String,Object>	getMap(Preferences prefs, String node, Class clazz, Object def) Returns the Map represented by the string associated with the specified node in this preference node.
static <C> Map<String,C>	getMapForClass(Preferences prefs, String node, Class<C> clazz, Object def) Returns the Map represented by the string associated with the specified node in this preference node.
static List<Number>	getNumbers(Preferences prefs, String key, Class clazz) Returns the List of Numbers represented by the string associated with the specified key in this preference node.
static Object	getObject(Preferences prefs, String key) Returns the Object value represented by the string associated with the specified key in this preference node.
static Object	getObject(Preferences prefs, String key, Object def) Returns the Object value represented by the string associated with the specified key in this preference node.
static String[]	getStringArray(Preferences prefs, String node, String def) Returns the String[] represented by the string associated with the specified node in this preference node.
static Preferences	putBooleanArray(Preferences prefs, String node, boolean[] array) Creates a new preferences node that will store the associated boolean array under the current Node.
static void	putFile(Preferences prefs, String key, File file) Associates a string representing the specified File with the specified key in this preference node.
static void	putFileName(Preferences prefs, String key, String fileName) Associates a string representing the specified File name with the specified key in this preference node.
static void	putFileRelativeTo(Preferences prefs, String key, File file, File dir) Associates a string representing the specified File with the specified key in this preference node.
static Preferences	putFiles(Preferences prefs, String node, File[] files) Creates a new preferences node that will store the associated Files under the current Node.
static Preferences	putFilesRelativeTo(Preferences prefs, String node, File[] files, File dir) Creates a new preferences node that will store the associated Files under the current Node.
static Preferences	putMap(Preferences prefs, String key, Map<String,Object> map) Creates a new preferences node that will store the associated Map under the current Node.
static <C> Preferences	putMapForClass(Preferences prefs, String key, Map<String,C> map) Creates a new preferences node that will store the associated Map under the current Node.
static void	putNumbers(Preferences prefs, String key, List<Number> numbers) Creates a new preferences node that will store a list of numbers under the current Node.
static void	putNumbers(Preferences prefs, String key, Number... numbers) Creates a new preferences node that will store a list of numbers under the current Node.
static Preferences	putObject(Preferences prefs, String key, Object o) Creates a new preferences node that will store a serialized Object the current Node.
static Preferences	putStringArray(Preferences prefs, String node, String[] array) Creates a new preferences node that will store the associated String array under the current Node.

Methods inherited from class java.lang.Object

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

Constructor Detail

PreferencesHelper

public PreferencesHelper()

Method Detail

putFileRelativeTo

public static void putFileRelativeTo(Preferences prefs,
                                     String key,
                                     File file,
                                     File dir)

Associates a string representing the specified File with the specified key in this preference node. The File will be stored with its relative or absolute pathname String, depending on if it is under the reference directory (even under one of its sub-directories) or not. It is guaranteed that the associated stored value will be a valid escaped UTF8 character sequence.

Parameters:

prefs - the preferences node

key - the key

file - the File

dir - the reference directory

putFile

public static void putFile(Preferences prefs,
                           String key,
                           File file)

Associates a string representing the specified File with the specified key in this preference node. The File will be stored with its absolute pathname String.

It is guaranteed that the associated stored value will be a valid escaped UTF8 character sequence.

Parameters:

prefs - the preferences node

key - the key

file - the File

putFileName

public static void putFileName(Preferences prefs,
                               String key,
                               String fileName)

Associates a string representing the specified File name with the specified key in this preference node.

Parameters:

prefs - the preferences node

key - the key

fileName - the File name

getFileName

public static String getFileName(Preferences prefs,
                                 String key,
                                 String path)

Returns the FileName represented by the string associated with the specified key in this preference node. In this case, if the key does not exist, the FileName will be replaced by the default pathname.

Parameters:

prefs - the preferences node

key - the key

path - the default path

Returns:

the File name

See Also:

putFileName(Preferences, String, String)

getFileRelativeTo

public static File getFileRelativeTo(Preferences prefs,
                                     String key,
                                     File defFile,
                                     File dir)

Returns the File represented by the string associated with the specified key in this preference node. In this case, if the key does not exist, the File will be replaced by the default File pathname.

Parameters:

prefs - the preferences node

key - the key

defFile - the default file to use if the value is not found in the Preferences

dir - the parent directory to use for relative files

Returns:

the File

See Also:

putFile(Preferences, String, File)

getFile

public static File getFile(Preferences prefs,
                           String key,
                           File defFile)

Returns the File represented by the string associated with the specified key in this preference node. In this case, if the key does not exist, the File will be replaced by the "" pathname.

Parameters:

prefs - the Preferences Node

key - the key

defFile - the default file

Returns:

the File represented by the string associated with the specified key

getFile

public static File getFile(Preferences prefs,
                           String key)

Returns the File represented by the string associated with the specified key in this preference node. In this case, if the key does not exist, the File will be replaced by the "" pathname.

Parameters:

prefs - the Preferences Node

key - the key

Returns:

the File represented by the string associated with the specified key

See Also:

getFile(Preferences, String, File)

putFilesRelativeTo

public static Preferences putFilesRelativeTo(Preferences prefs,
                                             String node,
                                             File[] files,
                                             File dir)

Creates a new preferences node that will store the associated Files under the current Node. The files will be stored relative to a directory if possible.

• The Files will be stored using the putFile(Preferences, String, File) under this node
• the template for the name of the keys for each file will be "element" <file index>, with index going from 0 to the files count in the Files input

Parameters:

prefs - the preferences

node - the Node

files - the files array

dir - the reference directory

Returns:

the node under which the file keys are created

putFiles

public static Preferences putFiles(Preferences prefs,
                                   String node,
                                   File[] files)

Creates a new preferences node that will store the associated Files under the current Node.

• The Files will be stored using the putFile(Preferences, String, File) under this node
• the template for the name of the keys for each file will be "element" <file index>, with index going from 0 to the files count in the Files input

Parameters:

prefs - the preferences

node - the Node

files - the files array

Returns:

the node under which the file keys are created

getFiles

public static File[] getFiles(Preferences prefs,
                              String node,
                              File[] defFiles)

Returns the File[] represented by the string associated with the specified node in this preference node. If this subnode does not exist, the Files will be replaced by the default files. It is guaranteed that the ordering of the returned files will be identical to the order in which they where initially put in the Preferences.

Parameters:

prefs - the preferences

node - the Node

defFiles - the default files array

Returns:

the files

See Also:

putFiles(Preferences, String, File[])

getFilesRelativeTo

public static File[] getFilesRelativeTo(Preferences prefs,
                                        String key,
                                        File[] defFiles,
                                        File dir)

Returns the File[] represented by the string associated with the specified node in this preference node. If this subnode does not exist, the Files will be replaced by the default files.

It is guaranteed that the ordering of the returned files will be identical to the order in which they where initially put in the Preferences.

Parameters:

prefs - the Preferences Node

key - the key

defFiles - the default files

dir - the reference directory.

Returns:

the files

See Also:

putFiles(Preferences, String, File[])

putStringArray

public static Preferences putStringArray(Preferences prefs,
                                         String node,
                                         String[] array)

Creates a new preferences node that will store the associated String array under the current Node.

• The Strings will be stored as values under this node
• the template for the name of the keys for each String will be "element" <string index>, with index going from 0 to the strings count in the strings input

Parameters:

prefs - the preferences

node - the Node

array - the String array

Returns:

the node under which the string keys are created

getStringArray

public static String[] getStringArray(Preferences prefs,
                                      String node,
                                      String def)

Returns the String[] represented by the string associated with the specified node in this preference node. If this subnode does not exist, the Strings will be replaced by the default string (an array with only one dimension). It is guaranteed that the ordering of the returned Strings will be identical to the order in which they where initially put in the Preferences.

Parameters:

prefs - the preferences

node - the Node

def - the default String used for every element in the array

Returns:

the String array

See Also:

putStringArray(Preferences, String, String[])

putBooleanArray

public static Preferences putBooleanArray(Preferences prefs,
                                          String node,
                                          boolean[] array)

Creates a new preferences node that will store the associated boolean array under the current Node.

• The booleans will be stored as values under this node
• the template for the name of the keys for each boolean will be "element" <string index>, with index going from 0 to the boolean count in the booleans input

Parameters:

prefs - the preferences

node - the Node

array - the boolean array

Returns:

the node under which the string keys are created

getBooleanArray

public static boolean[] getBooleanArray(Preferences prefs,
                                        String node,
                                        boolean def)

Returns the boolean[] represented by the string associated with the specified node in this preference node. If this subnode does not exist, the booleans will be replaced by the default boolean (an array with only one dimension).

It is guaranteed that the ordering of the returned booleans will be identical to the order in which they where initially put in the Preferences.

Parameters:

prefs - the preferences

node - the Node

def - the default boolean used for every element in the array

Returns:

the String array

See Also:

putBooleanArray(Preferences, String, boolean[])

putMapForClass

public static <C> Preferences putMapForClass(Preferences prefs,
                                             String key,
                                             Map<String,C> map)

Creates a new preferences node that will store the associated Map under the current Node.

• The Map elements will be stored as pairs of (key, String values) under this node

Type Parameters:

C - the class type

Parameters:

prefs - the Preferences

key - the key

map - the Map

Returns:

the node under which the Map as been created

putMap

public static Preferences putMap(Preferences prefs,
                                 String key,
                                 Map<String,Object> map)

Creates a new preferences node that will store the associated Map under the current Node.

• The Map elements will be stored as pairs of (key, String values) under this node

Parameters:

prefs - the Preferences

key - the key

map - the Map

Returns:

the node under which the Map as been created

getNumbers

public static List<Number> getNumbers(Preferences prefs,
                                      String key,
                                      Class clazz)

Returns the List of Numbers represented by the string associated with the specified key in this preference node.

Parameters:

prefs - the Preferences

key - the key

clazz - the Number class to use

Returns:

the List of Numbers

putNumbers

public static void putNumbers(Preferences prefs,
                              String key,
                              List<Number> numbers)

Creates a new preferences node that will store a list of numbers under the current Node. The list of Numbers will be stored as a String with this pattern:

     <number>;<number>;<number>;<number>
 

Parameters:

prefs - the Preferences

key - the key

numbers - the numbers

putNumbers

public static void putNumbers(Preferences prefs,
                              String key,
                              Number... numbers)

Creates a new preferences node that will store a list of numbers under the current Node. The list of Numbers will be stored as a String with this pattern:

     <number>;<number>;<number>;<number>
 

Parameters:

prefs - the Preferences

key - the key

numbers - the numbers

putObject

public static Preferences putObject(Preferences prefs,
                                    String key,
                                    Object o)

Creates a new preferences node that will store a serialized Object the current Node. Note that the object must be serializable.

Parameters:

prefs - the Preferences

key - the key

o - the Object

Returns:

the preference node.

getObject

public static Object getObject(Preferences prefs,
                               String key)

Returns the Object value represented by the string associated with the specified key in this preference node. Same as getObject(java.util.prefs.Preferences, java.lang.String, java.lang.Object) will a null Object.

Parameters:

prefs - the preferences

key - the key

Returns:

the associated Object

getObject

public static Object getObject(Preferences prefs,
                               String key,
                               Object def)

Returns the Object value represented by the string associated with the specified key in this preference node.

Parameters:

prefs - the preferences

key - the key

def - the default Object

Returns:

the associated Object

getMapForClass

public static <C> Map<String,C> getMapForClass(Preferences prefs,
                                               String node,
                                               Class<C> clazz,
                                               Object def)

Returns the Map represented by the string associated with the specified node in this preference node. If this subnode does not exist, the Map will be replaced by an empty Map.

Type Parameters:

C - the class type

Parameters:

prefs - the preferences

node - the Node

clazz - the Object class to use for the Map

def - the default Object

Returns:

the Map

See Also:

putBooleanArray(Preferences, String, boolean[])

getMap

public static Map<String,Object> getMap(Preferences prefs,
                                        String node,
                                        Class clazz,
                                        Object def)

Returns the Map represented by the string associated with the specified node in this preference node. If this subnode does not exist, the Map will be replaced by an empty Map.

Parameters:

prefs - the preferences

node - the Node

clazz - the Object class to use for the Map

def - the default Object

Returns:

the Map

See Also:

putBooleanArray(Preferences, String, boolean[])