org.compass.core.config
Class CompassSettings

java.lang.Object
  org.compass.core.config.CompassSettings

Direct Known Subclasses:

RuntimeCompassSettings

public class CompassSettings
extends Object

A set of settings that are used to configure the Compass instance.

Author:

kimchy

Constructor Summary

CompassSettings()

CompassSettings(Properties settings)

Method Summary

void	addSettings(CompassSettings settings)
void	addSettings(Properties settings)
CompassSettings	copy()
Properties	getProperties()
Object	getRegistry(Object key) ADANCE: An internal compass global registry
String	getSetting(String setting)
String	getSetting(String setting, String defaultValue)
boolean	getSettingAsBoolean(String setting, boolean defaultValue)
Class	getSettingAsClass(String setting, Class clazz)
Class	getSettingAsClass(String setting, Class clazz, ClassLoader classLoader)
float	getSettingAsFloat(String setting, float defaultValue)
int	getSettingAsInt(String setting, int defaultValue)
long	getSettingAsLong(String setting, long defaultValue)
Map	getSettingGroups(String settingPrefix)
Collection	keySet()
Object	removeRegistry(Object key) ADVANCE: An internal compass global registry
CompassSettings	setBooleanSetting(String setting, boolean value)
CompassSettings	setClassSetting(String setting, Class clazz)
CompassSettings	setFloatSetting(String setting, float value)
CompassSettings	setGroupSettings(String settingPrefix, String groupName, String[] settings, String[] values) Sets a group of settings, sharing the same setting prefix.
CompassSettings	setIntSetting(String setting, int value)
CompassSettings	setLongSetting(String setting, long value)
void	setRegistry(Object key, Object value) ADVANCE: An internal compass global registry
CompassSettings	setSetting(String setting, String value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CompassSettings

public CompassSettings()

CompassSettings

public CompassSettings(Properties settings)

Method Detail

addSettings

public void addSettings(Properties settings)

addSettings

public void addSettings(CompassSettings settings)

copy

public CompassSettings copy()

getProperties

public Properties getProperties()

keySet

public Collection keySet()

getSetting

public String getSetting(String setting)

getSetting

public String getSetting(String setting,
                         String defaultValue)

getSettingGroups

public Map getSettingGroups(String settingPrefix)

getSettingAsFloat

public float getSettingAsFloat(String setting,
                               float defaultValue)

getSettingAsInt

public int getSettingAsInt(String setting,
                           int defaultValue)

getSettingAsLong

public long getSettingAsLong(String setting,
                             long defaultValue)

getSettingAsBoolean

public boolean getSettingAsBoolean(String setting,
                                   boolean defaultValue)

getSettingAsClass

public Class getSettingAsClass(String setting,
                               Class clazz)
                        throws ClassNotFoundException

Throws:

ClassNotFoundException

getSettingAsClass

public Class getSettingAsClass(String setting,
                               Class clazz,
                               ClassLoader classLoader)
                        throws ClassNotFoundException

Throws:

ClassNotFoundException

setSetting

public CompassSettings setSetting(String setting,
                                  String value)

setBooleanSetting

public CompassSettings setBooleanSetting(String setting,
                                         boolean value)

setFloatSetting

public CompassSettings setFloatSetting(String setting,
                                       float value)

setIntSetting

public CompassSettings setIntSetting(String setting,
                                     int value)

setLongSetting

public CompassSettings setLongSetting(String setting,
                                      long value)

setClassSetting

public CompassSettings setClassSetting(String setting,
                                       Class clazz)

setGroupSettings

public CompassSettings setGroupSettings(String settingPrefix,
                                        String groupName,
                                        String[] settings,
                                        String[] values)

Sets a group of settings, sharing the same setting prefix. The provided settings are appended to the settingPrefix, and the matching values are set.

The constructed setting is: settingPrefix + "." + groupName + "." + settings[i].

Parameters:

settingPrefix - The prefix used for all settings

groupName - The name of the setting group

settings - The settings name appended to settingsPrefix + "." + groupName + "."

values - The values of the settings matched against the settings parameters

Returns:

This settings instance for method chaining

getRegistry

public Object getRegistry(Object key)

ADANCE: An internal compass global registry

setRegistry

public void setRegistry(Object key,
                        Object value)

ADVANCE: An internal compass global registry

removeRegistry

public Object removeRegistry(Object key)

ADVANCE: An internal compass global registry

toString

public String toString()

Overrides:

toString in class Object