net.datacrow.core.settings
Class Settings

java.lang.Object
  extended by net.datacrow.core.settings.Settings

public class Settings
extends java.lang.Object

Contains all Settings Groups and there settings. The Settings class is the only class which needs to be referenced to add groups, add settings, get settings and get values of settings.

Author:
Robert Jan van der Waals

Constructor Summary
Settings()
           
 
Method Summary
 void addGroup(java.lang.String key, SettingsGroup group)
          Adds a group to the hashtable.
 void addSetting(java.lang.String key, Setting setting)
          Adds a setting to a specified group.
 boolean getBoolean(java.lang.String key)
          Returns the value of the setting as a boolean
 java.awt.Color getColor(java.lang.String key)
          Returns the value of the setting as a color object
 IDefinitions getDefinitions(java.lang.String key)
           
 java.awt.Dimension getDimension(java.lang.String key)
           
 java.awt.Font getFont(java.lang.String key)
           
 java.util.Collection<SettingsGroup> getGroups()
          Retrieves all settings groups without an hierarchy
 int getInt(java.lang.String key)
          Returns the value of the setting as an integer
 int[] getIntArray(java.lang.String key)
           
 DcLookAndFeel getLookAndFeel(java.lang.String key)
           
 Setting getSetting(java.lang.String key)
          Retrieves a setting
 java.util.Collection<Setting> getSettings()
          Retrieves all the settings
 java.io.File getSettingsFile()
           
 java.util.LinkedHashMap<java.lang.String,SettingsGroup> getSettingsGroups()
          Retrieves all the top level groups
 java.lang.String getString(java.lang.String key)
           
 java.lang.String[] getStringArray(java.lang.String key)
          Returns the value of the setting as a String array
 java.lang.Object getValue(java.lang.String key)
          Retrieves a value of a settings
 boolean isSettingKeyValid(java.lang.String key)
           
 void setSettingsFile(java.io.File file)
          Specifies the location and name of the settings file
 void setString(java.lang.String key, java.lang.String s)
          Sets a string as a value for the setting (by parsing the string)
 void setValue(java.lang.String key, java.lang.Object value)
          Sets the value of a setting
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Settings

public Settings()
Method Detail

addGroup

public void addGroup(java.lang.String key,
                     SettingsGroup group)
Adds a group to the hashtable. A group may contain sub-groups. Only the parent, to which a sub-group belongs, should be added.

Parameters:
key - unique identifier for this group
group - a top-level group (parent)

setSettingsFile

public void setSettingsFile(java.io.File file)
Specifies the location and name of the settings file

Parameters:
file - the settings file

getSettingsFile

public java.io.File getSettingsFile()

addSetting

public void addSetting(java.lang.String key,
                       Setting setting)
Adds a setting to a specified group. A group can be either a parent or a child.

Parameters:
key - the key of the group
setting - the setting to be added to the specified group

isSettingKeyValid

public boolean isSettingKeyValid(java.lang.String key)

getSetting

public Setting getSetting(java.lang.String key)
Retrieves a setting


getValue

public java.lang.Object getValue(java.lang.String key)
Retrieves a value of a settings


getStringArray

public java.lang.String[] getStringArray(java.lang.String key)
Returns the value of the setting as a String array


getIntArray

public int[] getIntArray(java.lang.String key)

getDefinitions

public IDefinitions getDefinitions(java.lang.String key)

getFont

public java.awt.Font getFont(java.lang.String key)

getLookAndFeel

public DcLookAndFeel getLookAndFeel(java.lang.String key)

getInt

public int getInt(java.lang.String key)
Returns the value of the setting as an integer


getBoolean

public boolean getBoolean(java.lang.String key)
Returns the value of the setting as a boolean


getColor

public java.awt.Color getColor(java.lang.String key)
Returns the value of the setting as a color object


getDimension

public java.awt.Dimension getDimension(java.lang.String key)

getString

public java.lang.String getString(java.lang.String key)

setValue

public void setValue(java.lang.String key,
                     java.lang.Object value)
Sets the value of a setting


setString

public void setString(java.lang.String key,
                      java.lang.String s)
Sets a string as a value for the setting (by parsing the string)


getSettingsGroups

public java.util.LinkedHashMap<java.lang.String,SettingsGroup> getSettingsGroups()
Retrieves all the top level groups


getGroups

public java.util.Collection<SettingsGroup> getGroups()
Retrieves all settings groups without an hierarchy


getSettings

public java.util.Collection<Setting> getSettings()
Retrieves all the settings