public class JAPreferencesHandler
extends java.lang.Object
JAPreferencesHandler
provides the JA system with an
interface to the standard Java Preferences mechanism.Constructor and Description |
---|
JAPreferencesHandler()
JAPreferences handler constructor -- currently a no-op. |
Modifier and Type | Method and Description |
---|---|
void |
clear(java.lang.String node)
Clears the specified JARP preferences node.
|
void |
export(java.lang.String node,
java.io.OutputStream outs)
Exports the specified JARP preferences node to the specified
output-stream.
|
void |
export(java.lang.String node,
java.lang.String path)
Exports the specified JARP preferences node to the file with
the specified path.
|
static java.lang.String |
getSystemPreference(java.lang.String skey)
Loads and returns the jarp System preference identified by
the given key.
|
void |
importPreferences(java.io.InputStream ins)
Imports preferences definition(s) from the specified
input-stream -- just wraps a call to the corresponding
Preferences method. |
void |
importPreferences(java.lang.String path)
Imports preferences definition(s) from the file with the
specified path.
|
static java.util.prefs.Preferences |
jarpSystemRoot()
Returns the root node of the JARP System preferences hierarchy,
having first established the local reference to this node
if necessary.
|
java.util.prefs.Preferences |
jarpUserNode(java.lang.String node)
Returns the specified node in the JARP preferences hierarchy,
that is, the node with the specified path relative to the JARP
preferences root.
|
boolean |
jarpUserNodeIsAvailable(java.lang.String node)
Tests whether the specified node in the JARP preferences
hierarchy is available, that is, whether it exists and is
not the victim of a
BackingStoreException . |
java.util.prefs.Preferences |
jarpUserRoot()
Returns the root node of the JARP User preferences hierarchy,
having first established the local reference to this node
if necessary.
|
void |
load(java.lang.String node,
java.util.Properties props)
Loads the preferences at the specified JARP node, and enters
them into the given
Properties set. |
void |
reset(java.lang.String node,
java.util.Properties props)
Updates the specified JARP preferences node, by replacing it
it with the settings specified in the given
Properties . |
static void |
setSystemPreference(java.lang.String skey,
java.lang.String sval)
Sets the jarp System preference with the specified key to
the specified value.
|
void |
update(java.lang.String node,
java.util.Properties props)
Updates the specified JARP preferences node, by augmenting
it with the settings specified in the given
Properties . |
void |
updatePreference(java.lang.String node,
java.lang.String key,
java.lang.String value)
Updates the JARP preferences at the given node, with the given
key-value pair.
|
public JAPreferencesHandler()
JAPreferences
handler constructor -- currently a no-op.public java.util.prefs.Preferences jarpUserRoot()
public java.util.prefs.Preferences jarpUserNode(java.lang.String node)
public boolean jarpUserNodeIsAvailable(java.lang.String node)
BackingStoreException
.public void export(java.lang.String node, java.io.OutputStream outs) throws java.io.IOException, java.util.prefs.BackingStoreException
java.io.IOException
java.util.prefs.BackingStoreException
public void export(java.lang.String node, java.lang.String path) throws java.io.IOException, java.util.prefs.BackingStoreException
java.io.IOException
java.util.prefs.BackingStoreException
public void importPreferences(java.io.InputStream ins) throws java.io.IOException, java.util.prefs.InvalidPreferencesFormatException
Preferences
method.java.io.IOException
java.util.prefs.InvalidPreferencesFormatException
public void importPreferences(java.lang.String path) throws java.io.IOException, java.util.prefs.InvalidPreferencesFormatException
java.io.IOException
java.util.prefs.InvalidPreferencesFormatException
public void clear(java.lang.String node)
public void update(java.lang.String node, java.util.Properties props)
Properties
.public void reset(java.lang.String node, java.util.Properties props)
Properties
.public void updatePreference(java.lang.String node, java.lang.String key, java.lang.String value)
public void load(java.lang.String node, java.util.Properties props)
Properties
set.public static java.util.prefs.Preferences jarpSystemRoot()
public static java.lang.String getSystemPreference(java.lang.String skey)
public static void setSystemPreference(java.lang.String skey, java.lang.String sval)