org.ginsim.common.application

Class OptionStore

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.ginsim.common.application.OptionStore

All Implemented Interfaces:

ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class OptionStore
extends DefaultHandler

Handle options: remember them during the session, restore them when first called and save them when exiting.

Author:

Aurelien Naldi

Constructor Summary

Constructors

Constructor and Description
OptionStore()

Method Summary

Modifier and Type	Method and Description
static void	addRecentFile(String path) Add file path to recent file list.
static Object	getOption(String name) get the saved value of an option
static <T> T	getOption(String name, T defValue) get the saved value of an option with a fallback value.
static List<String>	getRecentFiles() Get the list of recent files.
static void	init(String name) Initialise the option store: this should be called by the launcher once and only once.
static void	removeOption(String name) remove a saved option.
static void	saveOptions() save all options in a file, to restore them at next run.
static void	setOption(String name, Object value) save the value of an option.
void	startElement(String uri, String localName, String qName, Attributes attributes) Handler to parse the saved file.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

characters, endDocument, endElement, endPrefixMapping, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, skippedEntity, startDocument, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

OptionStore

public OptionStore()

Method Detail

init

public static void init(String name)
                 throws Exception

Initialise the option store: this should be called by the launcher once and only once.

Parameters:

name -

Throws:

Exception

addRecentFile

public static void addRecentFile(String path)

Add file path to recent file list. The file will take the first position in the list.

Parameters:

path - the path to add to the list

getRecentFiles

public static List<String> getRecentFiles()

Get the list of recent files. Note: the recent menu will be managed by this class directly, this method should only be used to save the list of recent files before closing GINsim

Returns:

the list of recent files

setOption

public static void setOption(String name,
                             Object value)

save the value of an option. accepted types: Boolean, Integer, String

Parameters:

name - unique name (key) of the option

value - an object giving the value of this option

getOption

public static Object getOption(String name)

get the saved value of an option

Parameters:

name - uniq name (key) of the option

Returns:

an object representing the value of this option (null if not defined)

getOption

public static <T> T getOption(String name,
                              T defValue)

get the saved value of an option with a fallback value. If the option was not defined or if types mismatch, it will be set to the default value.

Parameters:

name - unique name (key) of the option

defValue - value to return if this option is not defined

Returns:

an object representing the value of this option

removeOption

public static void removeOption(String name)

remove a saved option.

Parameters:

name - unique name (key) of the option

saveOptions

public static void saveOptions()

save all options in a file, to restore them at next run.

startElement

public void startElement(String uri,
                         String localName,
                         String qName,
                         Attributes attributes)
                  throws SAXException

Handler to parse the saved file.

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException