net.sf.doolin.gui.service
Interface GUIPreferences

All Known Implementing Classes:

AbstractGUIPreferences, DefaultGUIPreferences, PropertyFileGUIPreferences

public interface GUIPreferences

Interface to the preferences of the application.

Author:

Damien Coraboeuf

Method Summary

void	delete(String key) Deletes a preference entry.
Boolean	getBoolean(String key, Boolean defaultValue) Get a preference value as a boolean
File	getFile(String key) Gets a preference value as a file.
Integer	getInt(String key, Integer defaultValue) Get a preference value as an integer
Long	getLong(String key, Long defaultValue) Get a preference value as a long
String	getString(String key, String defaultValue) Get a preference value as a string
void	restoreMemento(Memento memento) Restores a Memento from the preferences.
void	save() Saves the preferences in the back store
void	saveMemento(Memento memento) Saves a Memento in the preferences.
void	setBoolean(String key, Boolean value) Sets a preference value as a string
void	setFile(String key, File file) Sets a preference value as a file.
void	setInt(String key, Integer value) Sets a preference value as an integer
void	setLong(String key, Long value) Sets a preference value as a long
void	setString(String key, String value) Sets a preference value as a string

Method Detail

getString

String getString(String key,
                 String defaultValue)

Get a preference value as a string

Parameters:

key - Preference key

defaultValue - Default value if the key is not defined

Returns:

Preference value

getBoolean

Boolean getBoolean(String key,
                   Boolean defaultValue)

Get a preference value as a boolean

Parameters:

key - Preference key

defaultValue - Default value if the key is not defined

Returns:

Preference value

getInt

Integer getInt(String key,
               Integer defaultValue)

Get a preference value as an integer

Parameters:

key - Preference key

defaultValue - Default value if the key is not defined

Returns:

Preference value

setString

void setString(String key,
               String value)

Sets a preference value as a string

Parameters:

key - Preference key

value - Value to store

setBoolean

void setBoolean(String key,
                Boolean value)

Sets a preference value as a string

Parameters:

key - Preference key

value - Value to store

setInt

void setInt(String key,
            Integer value)

Sets a preference value as an integer

Parameters:

key - Preference key

value - Value to store

setLong

void setLong(String key,
             Long value)

Sets a preference value as a long

Parameters:

key - Preference key

value - Value to store

save

void save()

Saves the preferences in the back store

getFile

File getFile(String key)

Gets a preference value as a file.

Parameters:

key - Preference key

Returns:

File or null if not found

setFile

void setFile(String key,
             File file)

Sets a preference value as a file.

Parameters:

key - Preference key

file - File to store

saveMemento

void saveMemento(Memento memento)

Saves a Memento in the preferences.

Parameters:

memento - Memento to save

restoreMemento

void restoreMemento(Memento memento)

Restores a Memento from the preferences.

Parameters:

memento - Memento to restore

delete

void delete(String key)

Deletes a preference entry.

Parameters:

key - Preference entry key

getLong

Long getLong(String key,
             Long defaultValue)

Get a preference value as a long

Parameters:

key - Preference key

defaultValue - Default value if the key is not defined

Returns:

Preference value