org.argouml.configuration
Class ConfigurationHandler

java.lang.Object
  org.argouml.configuration.ConfigurationHandler

public abstract class ConfigurationHandler
extends java.lang.Object

This class provides a user configuration based upon properties. This provides an implementation-free interface to a configuration repository. Any classes which need to implement a configuration datastore must extend this class. All of the required behavioral logic for the configuration is contained within this class, as public final methods. Any storage-related logic must be handled by the extending class. These methods are abstract. This class is intimately related to Configuration.

Since:

0.9.4

ConfigurationHandler

public ConfigurationHandler()

Anonymous constructor allows configuration changes.

ConfigurationHandler

public ConfigurationHandler(boolean c)

Constructor which optionally allows configuration changes.

Parameters:

c - indicates if the configuration can be changed

getDefaultPath

public abstract java.lang.String getDefaultPath()

Returns a default configuration path. This could be a filename or a URL. It is not guaranteed to be usable across different implementations of ConfigurationHandler.

Returns:

the default configuration path or url.

loadDefault

public final boolean loadDefault()

Load the configuration from the default location.

Returns:

true if this call loaded the configuration, otherwise false, not distinguishing between a load error or a previously loaded configuration.

See Also:

isLoaded()

saveDefault

public final boolean saveDefault()

Save the configuration to the location it was loaded from. Do not force it if the configuration was not loaded already.

Returns:

true if the save was successful, false if it was not attempted or encountered an error.

saveDefault

public final boolean saveDefault(boolean force)

Save the configuration to the location it was loaded from.

Parameters:

force - the save even if it would not normally be done.

Returns:

true if the save was successful, false if it was not attempted or encountered an error.

isChangeable

public final boolean isChangeable()

Indicates whether the configuration can be saved.

Returns:

true if the configuration can be saved.

isLoaded

public final boolean isLoaded()

Indicates whether the configuration has been loaded.

Returns:

true if the configuration has been loaded.

load

public final boolean load(java.io.File file)

Load the configuration from a File.

Parameters:

file - to load from.

Returns:

true if this call loaded the configuration, otherwise false, not distinguishing between a load error or a previously loaded configuration.

load

public final boolean load(java.net.URL url)

Load the configuration from a URL.

Parameters:

url - to load from.

Returns:

true if this call loaded the configuration, otherwise false, not distinguishing between a load error or a previously loaded configuration.

save

public final boolean save(java.io.File file)

Save the configuration to a File.

Parameters:

file - to save to.

Returns:

true if this call saved the configuration, otherwise false.

save

public final boolean save(java.net.URL url)

Save the configuration to a URL.

Parameters:

url - to save to.

Returns:

true if this call saved the configuration, otherwise false.

getString

public final java.lang.String getString(ConfigurationKey key,
                                        java.lang.String defaultValue)

Returns the string value of a configuration property.

Parameters:

key - the configuration key to return.

defaultValue - the default value key to return if the key is not found.

Returns:

the value of the key or the default value if the key does not exist.

getInteger

public final int getInteger(ConfigurationKey key,
                            int defaultValue)

Returns the numeric value of a configuration property.

Parameters:

key - the configuration key to return.

defaultValue - the default value key to return if the key is not found.

Returns:

the value of the key or the default value if the key does not exist.

getDouble

public final double getDouble(ConfigurationKey key,
                              double defaultValue)

Returns the numeric value of a configuration property.

Parameters:

key - the configuration key to return.

defaultValue - the default value key to return if the key is not found.

Returns:

the value of the key or the default value if the key does not exist.

getBoolean

public final boolean getBoolean(ConfigurationKey key,
                                boolean defaultValue)

Returns the boolean value of a configuration property.

Parameters:

key - the configuration key to return.

defaultValue - the default value key to return if the key is not found.

Returns:

the value of the key or the default value if the key does not exist.

setString

public final void setString(ConfigurationKey key,
                            java.lang.String newValue)

Sets the string value of a configuration property.

Parameters:

key - the configuration key to modify.

newValue - the value to set the key to.

setInteger

public final void setInteger(ConfigurationKey key,
                             int value)

Sets the numeric value of a configuration property.

Parameters:

key - the configuration key to modify.

value - the value to set the key to.

setDouble

public final void setDouble(ConfigurationKey key,
                            double value)

Sets the numeric value of a configuration property.

Parameters:

key - the configuration key to modify.

value - the value to set the key to.

setBoolean

public final void setBoolean(ConfigurationKey key,
                             boolean value)

Sets the boolean value of a configuration property.

Parameters:

key - the configuration key to modify.

value - the value to set the key to.

addListener

public final void addListener(java.beans.PropertyChangeListener p)

Adds a property change listener.

Parameters:

p - The class which will listen for property changes.

removeListener

public final void removeListener(java.beans.PropertyChangeListener p)

Removes a property change listener.

Parameters:

p - The class to remove as a property change listener.

addListener

public final void addListener(ConfigurationKey key,
                              java.beans.PropertyChangeListener p)

Adds a property change listener.Static for simplicity of use.

Parameters:

key - The specific key to listen for.

p - The class which will listen for property changes.

removeListener

public final void removeListener(ConfigurationKey key,
                                 java.beans.PropertyChangeListener p)

Removes a property change listener.

Parameters:

key - The specific key being listened for.

p - The class to remove as a property change listener.

loadFile

public abstract boolean loadFile(java.io.File file)

Internal processing to load a File.

Parameters:

file - the file to load.

Returns:

true if the load was successful, otherwise false.

loadURL

public abstract boolean loadURL(java.net.URL url)

Internal processing to load a URL.

Parameters:

url - the url to load.

Returns:

true if the load was successful, otherwise false.

saveFile

public abstract boolean saveFile(java.io.File file)

Internal processing to save a File.

Parameters:

file - the file to save.

Returns:

true if the save was successful, otherwise false.

saveURL

public abstract boolean saveURL(java.net.URL url)

Internal processing to save a URL.

Parameters:

url - the url to save.

Returns:

true if the save was successful, otherwise false.

hasKey

public boolean hasKey(ConfigurationKey key)

Allows query for the existence of a configuration property. This may be overridden if the implementation has a more efficient method.

Parameters:

key - the property being checked.

Returns:

true if the key exists, otherwise false.

getValue

public abstract java.lang.String getValue(java.lang.String key,
                                          java.lang.String defaultValue)

Returns the string value of a configuration property.

Parameters:

key - the configuration key to return.

defaultValue - the configuration key to return.

Returns:

the value of the key or the default value if the key does not exist.

setValue

public abstract void setValue(java.lang.String key,
                              java.lang.String value)

Sets the string value of a configuration property.

Parameters:

key - the configuration key to modify.

value - the value to set the key to.

remove

public abstract void remove(java.lang.String key)

Remove the property and the assotiated value.

Parameters:

key - The key to remove.