org.openbp.common.setting
Class FixedSettingProvider

java.lang.Object
  extended by org.openbp.common.setting.FixedSettingProvider
All Implemented Interfaces:
SettingProvider

public final class FixedSettingProvider
extends java.lang.Object
implements SettingProvider

Implementation of a setting provider that supports access to System properties. The returned setting values are always strings.

Author:
Heiko Erhardt

Constructor Summary
FixedSettingProvider()
          Constructor.
 
Method Summary
 void define(java.lang.String name, java.lang.Object value)
          Defines a new setting.
 java.lang.Object getSetting(java.lang.String name)
          Gets a setting value.
 java.util.Map getSettings()
          Gets the settings.
 boolean loadSettings()
          Loads the settings.
 boolean saveSettings()
          Saves the settings.
 boolean setSetting(java.lang.String name, java.lang.Object value)
          Sets a setting.
 void setSettings(java.util.Map settings)
          Sets the settings.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FixedSettingProvider

public FixedSettingProvider()
Constructor.

Method Detail

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

define

public void define(java.lang.String name,
                   java.lang.Object value)
Defines a new setting.

Parameters:
name - Name of the setting
value - The setting value

getSetting

public java.lang.Object getSetting(java.lang.String name)
Gets a setting value.

Specified by:
getSetting in interface SettingProvider
Parameters:
name - Name of the setting
Returns:
The setting value or null if the setting does not exist

setSetting

public boolean setSetting(java.lang.String name,
                          java.lang.Object value)
Sets a setting. Fixed properties cannot be saved, so the method returns always false.

Specified by:
setSetting in interface SettingProvider
Parameters:
name - Name of the setting
value - Value of the setting
Returns:
false

loadSettings

public boolean loadSettings()
Loads the settings. Does nothing.

Specified by:
loadSettings in interface SettingProvider
Returns:
true

saveSettings

public boolean saveSettings()
Saves the settings. Does nothing.

Specified by:
saveSettings in interface SettingProvider
Returns:
true

getSettings

public java.util.Map getSettings()
Gets the settings.


setSettings

public void setSettings(java.util.Map settings)
Sets the settings.



Copyright © 2011. All Rights Reserved.