ConfigFile Class Reference

Class used to access configuration data. More...

Inheritance diagram for ConfigFile:

[legend]Collaboration diagram for ConfigFile:

[legend]List of all members.

Public Member Functions

• void ConfigFile (File file)

  Create new ConfigFile object.
  

• void unregisterListener (Object token)

  Remove config option change listener.
  

• void setOption (Object scope, String name, Object value)

  Set value of option.
  

• bool hasOption (Object scope, String name)

  Check that option of this name exists.
  

• void removeOption (Object scope, String name)

  Remove option.
  

• Object registerListener (Object scope, String name, ConfigChangeListener listener, void token)

  Add change listener to this object.
  

• Object getOption (Object scope, String name, Object defaultValue)

  Get previously stored option.
  

---

Detailed Description

Class used to access configuration data.

---

Constructor & Destructor Documentation

void ConfigFile (  File  file  )

Create new ConfigFile object. Parameters: file  File object which will be used to store configuration data.

---

Member Function Documentation

Object getOption (  Object  scope, String  name, Object  defaultValue )

Get previously stored option. Parameters: scope  Unused. name  Name of configuration option. defaultValue  Object which will be returned when value with name name wasn't stored in Config. Returns: Value stored in configuration in key name, or null when value with this key was not stored. Reimplemented from Config.

bool hasOption (  Object  scope, String  name )

Check that option of this name exists. Parameters: scope  Unused. name  Name of configuration option. Returns: true if option of name name exists, false otherwise. Reimplemented from Config.

Object registerListener (  Object  scope, String  name, ConfigChangeListener  listener, void  token )

Add change listener to this object. Parameters: scope  Unused. name  Name of config option, information abouts its chages will be passed to listener. listener  Listener object to add. Returns: Object which can be used to remove listener. Should be passed as token argument ot unregisterListener() method.

void removeOption (  Object  scope, String  name )

Remove option. Parameters: scope  Unused. name  Name of configuration option. Reimplemented from Config.

void setOption (  Object  scope, String  name, Object  value )

Set value of option. Parameters: scope  Unused. name  Name of configuration option. value  Value to store Reimplemented from Config.

void unregisterListener (  Object  token  )

Remove config option change listener. Parameters: token  Object returned by registerListener() method. Reimplemented from Config.

---

The documentation for this class was generated from the following file:

• configfile.js

---