de.bensoft.acis.utils

Class Preferences

java.lang.Object

de.bensoft.acis.utils.Preferences

public class Preferences
extends java.lang.Object

Represents a class to help storing settings (preferences) in a file.
A preference consists of a unique name and a corresponding value.
The preferences file is UTF-8 encoded.

Constructor Summary

Constructors

Constructor and Description
Preferences(IOUtils.SavingConfig config) Creates a new Preferences Object using the file in the IOUtils.SavingConfig.

Method Summary

Modifier and Type	Method and Description
java.lang.String	get(java.lang.String name, java.lang.String def) Fetches the value of the given preference's name.
IOUtils.SavingConfig	getPreferenceConfig() Returns the used IOUtils.SavingConfig.
boolean	has(java.lang.String name) Checks whether a preference entry exists.
void	remove(java.lang.String name) Removes a preference entry.
void	setPreferenceConfig(IOUtils.SavingConfig config) Sets the IOUtils.SavingConfig.
void	write(java.lang.String name, java.lang.String value) Creates a new preference entry with a name and a value or overrides the value if a preference entry with the same name already exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

Preferences

public Preferences(IOUtils.SavingConfig config)

Creates a new Preferences Object using the file in the IOUtils.SavingConfig.

Parameters:

config - The IOUtils.SavingConfig to use.

Method Detail

setPreferenceConfig

public void setPreferenceConfig(IOUtils.SavingConfig config)

Sets the IOUtils.SavingConfig.

Parameters:

config - The IOUtils.SavingConfig to set.

getPreferenceConfig

public IOUtils.SavingConfig getPreferenceConfig()

Returns the used IOUtils.SavingConfig.

Returns:

The IOUtils.SavingConfig.

get

public java.lang.String get(java.lang.String name,
                            java.lang.String def)

Fetches the value of the given preference's name.

Parameters:

name - The name of the preference to return the value of.

def - The value that is returned when the preference with name could not be found.

Returns:

The value for the preference name or def when name could not be found.

write

public void write(java.lang.String name,
                  java.lang.String value)

Creates a new preference entry with a name and a value or overrides the value if a preference entry with the same name already exists.

Parameters:

name - The name of the preference to write.

value - The corresponding value. Old value will be overridden if name already exists.

has

public boolean has(java.lang.String name)

Checks whether a preference entry exists.

Parameters:

name - The name of the preference to check for.

Returns:

true when it exists, else false.

remove

public void remove(java.lang.String name)

Removes a preference entry.

Parameters:

name - The name of the preference to remove.