org.mdi.bootstrap.prefs

Class PreferencesHelper

java.lang.Object

org.mdi.bootstrap.prefs.PreferencesHelper

public class PreferencesHelper
extends java.lang.Object

This class helps to put and get values to Preferences for object types which are not direcly handled in the core java Preferences class.

Method Summary

Modifier and Type	Method and Description
static java.io.File	getFile(java.util.prefs.Preferences prefs, java.lang.String key) Returns the File represented by the string associated with the specified key in this preference node.
static java.io.File	getFile(java.util.prefs.Preferences prefs, java.lang.String key, java.io.File defFile) Returns the File represented by the string associated with the specified key in this preference node.
static java.lang.String	getFileName(java.util.prefs.Preferences prefs, java.lang.String key, java.lang.String path) Returns the FileName represented by the string associated with the specified key in this preference node.
static java.io.File	getFileRelativeTo(java.util.prefs.Preferences prefs, java.lang.String key, java.io.File defFile, java.io.File dir) Returns the File represented by the string associated with the specified key in this preference node.
static void	putFile(java.util.prefs.Preferences prefs, java.lang.String key, java.io.File file) Associates a string representing the specified File with the specified key in this preference node.
static void	putFileName(java.util.prefs.Preferences prefs, java.lang.String key, java.lang.String fileName) Associates a string representing the specified File name with the specified key in this preference node.
static void	putFileRelativeTo(java.util.prefs.Preferences prefs, java.lang.String key, java.io.File file, java.io.File dir) Associates a string representing the specified File with the specified key in this preference node.

Methods inherited from class java.lang.Object

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

Method Detail

putFileRelativeTo

public static void putFileRelativeTo(java.util.prefs.Preferences prefs,
                                     java.lang.String key,
                                     java.io.File file,
                                     java.io.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(java.util.prefs.Preferences prefs,
                           java.lang.String key,
                           java.io.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(java.util.prefs.Preferences prefs,
                               java.lang.String key,
                               java.lang.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 java.lang.String getFileName(java.util.prefs.Preferences prefs,
                                           java.lang.String key,
                                           java.lang.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 java.io.File getFileRelativeTo(java.util.prefs.Preferences prefs,
                                             java.lang.String key,
                                             java.io.File defFile,
                                             java.io.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 java.io.File getFile(java.util.prefs.Preferences prefs,
                                   java.lang.String key,
                                   java.io.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 java.io.File getFile(java.util.prefs.Preferences prefs,
                                   java.lang.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)