gnu.java.util.prefs

Class FileBasedPreferences


public class FileBasedPreferences
extends AbstractPreferences

This is a simple file-based preference implementation which writes the preferences as properties files. A node is represented as a directory beneath the user's home directory. The preferences for the node are stored in a single properties file in that directory. Sub-nodes are stored in subdirectories. This implementation uses file locking to mediate access to the properties files.

Field Summary

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

Method Summary

protected AbstractPreferences
childSpi(String name)
protected String[]
childrenNamesSpi()
protected void
flushSpi()
protected String
getSpi(String key)
boolean
isUserNode()
Returns true if this node comes from the user preferences tree, false if it comes from the system preferences tree.
protected String[]
keysSpi()
protected void
putSpi(String key, String value)
protected void
removeNodeSpi()
protected void
removeSpi(String key)
protected void
syncSpi()

Methods inherited from class java.util.prefs.AbstractPreferences

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

Methods inherited from class java.util.prefs.Preferences

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

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

childSpi

protected AbstractPreferences childSpi(String name)
Overrides:
childSpi in interface AbstractPreferences

childrenNamesSpi

protected String[] childrenNamesSpi()
            throws BackingStoreException
Overrides:
childrenNamesSpi in interface AbstractPreferences

flushSpi

protected void flushSpi()
            throws BackingStoreException
Overrides:
flushSpi in interface AbstractPreferences

getSpi

protected String getSpi(String key)
Overrides:
getSpi in interface AbstractPreferences

isUserNode

public boolean isUserNode()
Returns true if this node comes from the user preferences tree, false if it comes from the system preferences tree.
Overrides:
isUserNode in interface AbstractPreferences

keysSpi

protected String[] keysSpi()
            throws BackingStoreException
Overrides:
keysSpi in interface AbstractPreferences

putSpi

protected void putSpi(String key,
                      String value)
Overrides:
putSpi in interface AbstractPreferences

removeNodeSpi

protected void removeNodeSpi()
            throws BackingStoreException
Overrides:
removeNodeSpi in interface AbstractPreferences

removeSpi

protected void removeSpi(String key)
Overrides:
removeSpi in interface AbstractPreferences

syncSpi

protected void syncSpi()
            throws BackingStoreException
Overrides:
syncSpi in interface AbstractPreferences

FileBasedPreferences.java -- File-based preference implementation Copyright (C) 2006 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.