org.fuin.utils4j

Class PropertiesFilePreferences

java.lang.Object

java.util.prefs.Preferences

java.util.prefs.AbstractPreferences

org.fuin.utils4j.PropertiesFilePreferences

public final class PropertiesFilePreferences
extends java.util.prefs.AbstractPreferences

A directory and PropertiesFile based Preferences API implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FILENAME Filename the properties of this node are stored under.

Fields inherited from class java.util.prefs.AbstractPreferences

lock, newNode

Fields inherited from class java.util.prefs.Preferences

MAX_KEY_LENGTH, MAX_NAME_LENGTH, MAX_VALUE_LENGTH

Constructor Summary

Constructors

Constructor and Description
PropertiesFilePreferences(java.io.File dir) Constructor with directory.
PropertiesFilePreferences(java.io.File dir, java.lang.String propFileName) Constructor with directory.
PropertiesFilePreferences(PropertiesFilePreferences parent, java.io.File dir) Constructor with parent node and directory.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String[]	childrenNamesSpi()
protected java.util.prefs.AbstractPreferences	childSpi(java.lang.String name)
protected void	flushSpi()
protected java.lang.String	getSpi(java.lang.String key)
protected java.lang.String[]	keysSpi()
protected void	putSpi(java.lang.String key, java.lang.String value)
protected void	removeNodeSpi()
protected void	removeSpi(java.lang.String key)
protected void	syncSpi()
java.util.Properties	toProperties() Returns a copy of all properties.

Methods inherited from class java.util.prefs.AbstractPreferences

absolutePath, addNodeChangeListener, addPreferenceChangeListener, cachedChildren, childrenNames, clear, exportNode, exportSubtree, flush, get, getBoolean, getByteArray, getChild, getDouble, getFloat, getInt, getLong, isRemoved, isUserNode, keys, name, node, nodeExists, parent, put, putBoolean, putByteArray, putDouble, putFloat, putInt, putLong, remove, removeNode, removeNodeChangeListener, removePreferenceChangeListener, sync, toString

Methods inherited from class java.util.prefs.Preferences

importPreferences, systemNodeForPackage, systemRoot, userNodeForPackage, userRoot

Methods inherited from class java.lang.Object

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

Field Detail

FILENAME

public static final java.lang.String FILENAME

Filename the properties of this node are stored under.

See Also:

Constant Field Values

Constructor Detail

PropertiesFilePreferences

public PropertiesFilePreferences(java.io.File dir)

Constructor with directory. This is constructing the "root" node.

Parameters:

dir - Directory where the preferences are stored.

PropertiesFilePreferences

public PropertiesFilePreferences(java.io.File dir,
                                 java.lang.String propFileName)

Constructor with directory. This is constructing the "root" node.

Parameters:

dir - Directory where the preferences are stored.

propFileName - the properties file name where the properties will be stored.

PropertiesFilePreferences

public PropertiesFilePreferences(PropertiesFilePreferences parent,
                                 java.io.File dir)

Constructor with parent node and directory.

Parameters:

parent - Parent node.

dir - Directory where the preferences are stored.

Method Detail

childSpi

protected final java.util.prefs.AbstractPreferences childSpi(java.lang.String name)

Specified by:

childSpi in class java.util.prefs.AbstractPreferences

childrenNamesSpi

protected final java.lang.String[] childrenNamesSpi()
                                             throws java.util.prefs.BackingStoreException

Specified by:

childrenNamesSpi in class java.util.prefs.AbstractPreferences

Throws:

java.util.prefs.BackingStoreException

flushSpi

protected void flushSpi()
                 throws java.util.prefs.BackingStoreException

Specified by:

flushSpi in class java.util.prefs.AbstractPreferences

Throws:

java.util.prefs.BackingStoreException

getSpi

protected final java.lang.String getSpi(java.lang.String key)

Specified by:

getSpi in class java.util.prefs.AbstractPreferences

keysSpi

protected final java.lang.String[] keysSpi()
                                    throws java.util.prefs.BackingStoreException

Specified by:

keysSpi in class java.util.prefs.AbstractPreferences

Throws:

java.util.prefs.BackingStoreException

putSpi

protected final void putSpi(java.lang.String key,
                            java.lang.String value)

Specified by:

putSpi in class java.util.prefs.AbstractPreferences

removeNodeSpi

protected final void removeNodeSpi()
                            throws java.util.prefs.BackingStoreException

Specified by:

removeNodeSpi in class java.util.prefs.AbstractPreferences

Throws:

java.util.prefs.BackingStoreException

removeSpi

protected final void removeSpi(java.lang.String key)

Specified by:

removeSpi in class java.util.prefs.AbstractPreferences

syncSpi

protected final void syncSpi()
                      throws java.util.prefs.BackingStoreException

Specified by:

syncSpi in class java.util.prefs.AbstractPreferences

Throws:

java.util.prefs.BackingStoreException

toProperties

public final java.util.Properties toProperties()

Returns a copy of all properties.

Returns:

All key/values without deleted ones.