org.sapia.soto
Class Settings

java.lang.Object
  org.sapia.soto.Settings

All Implemented Interfaces:

java.io.Serializable

public class Settings
extends java.lang.Object
implements java.io.Serializable

An instance of this class keeps strongly-typed application settings. It offers methods to a) add settings; b) read settings; c) test for the existence of given settings.

A setting is a name/value pair, where the value can be a String, an int, a long, a float, or a double.

For the getter methods that allow reading settings (getXXX) without a passed in default value, an IllegalStateException will be thrown if no corresponding setting could be found. In the case of the getter methods that allow passing in a default value, that value will be returned if no corresponding setting could be found.

To test for the existence of a given setting, call the exists(String) method.

Author:

yduchesne

See Also:

Env.getSettings(), EnvAware, Serialized Form

Constructor Summary

Settings()

Settings(java.util.Map settings)

Method Summary

void	addBoolean(java.lang.String name, boolean value)
void	addDouble(java.lang.String name, double value)
void	addFloat(java.lang.String name, float value)
void	addInt(java.lang.String name, int value)
void	addLong(java.lang.String name, long value)
void	addString(java.lang.String name, java.lang.String value)
boolean	exists(java.lang.String name)
boolean	getBoolean(java.lang.String name)
boolean	getBoolean(java.lang.String name, boolean dflt)
double	getDouble(java.lang.String name)
double	getDouble(java.lang.String name, double dflt)
float	getFloat(java.lang.String name)
float	getFloat(java.lang.String name, float dflt)
int	getInt(java.lang.String name)
int	getInt(java.lang.String name, int dflt)
long	getLong(java.lang.String name)
long	getLong(java.lang.String name, long dflt)
java.util.Properties	getProperties()
java.util.Map	getSettings()
java.lang.String	getString(java.lang.String name)
java.lang.String	getString(java.lang.String name, java.lang.String dflt)

Methods inherited from class java.lang.Object

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

Constructor Detail

Settings

public Settings()

Settings

public Settings(java.util.Map settings)

Method Detail

addString

public void addString(java.lang.String name,
                      java.lang.String value)

addInt

public void addInt(java.lang.String name,
                   int value)

addLong

public void addLong(java.lang.String name,
                    long value)

addFloat

public void addFloat(java.lang.String name,
                     float value)

addDouble

public void addDouble(java.lang.String name,
                      double value)

addBoolean

public void addBoolean(java.lang.String name,
                       boolean value)

exists

public boolean exists(java.lang.String name)

getString

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

getString

public java.lang.String getString(java.lang.String name,
                                  java.lang.String dflt)

getInt

public int getInt(java.lang.String name)

getInt

public int getInt(java.lang.String name,
                  int dflt)

getLong

public long getLong(java.lang.String name)

getLong

public long getLong(java.lang.String name,
                    long dflt)

getFloat

public float getFloat(java.lang.String name)

getFloat

public float getFloat(java.lang.String name,
                      float dflt)

getDouble

public double getDouble(java.lang.String name)

getDouble

public double getDouble(java.lang.String name,
                        double dflt)

getBoolean

public boolean getBoolean(java.lang.String name)

getBoolean

public boolean getBoolean(java.lang.String name,
                          boolean dflt)

getProperties

public java.util.Properties getProperties()

Returns:

returns this instance's settings as properties.

getSettings

public java.util.Map getSettings()

Returns:

this instance's settings, in an unmodifiable Map.