com.solarmetric.conf
Interface Configuration

All Superinterfaces:

BeanInfo, com.solarmetric.util.Closeable, Serializable

All Known Subinterfaces:

ClientConfiguration, JDBCConfiguration, JDOConfiguration, JDOConnectionFactory, JDOManagedConnectionFactory

All Known Implementing Classes:

ConfigurationImpl

public interface Configuration

extends BeanInfo, Serializable, com.solarmetric.util.Closeable

Interface for generic configuration objects. Includes the ability to write configuration to and from Properties instances.

Any property names ending in Properties can be used to configure the object they pertain to using a simple space-delimited, properties-style string. For example, if a hypothetical property LogFactoryClass is set to a class with methods setLogFile (String) and setAppend (boolean), then these properties can be automatically set on the instance instantiated from this class by specifying a LogFactoryProperties string like: 'logFile=/tmp/log.txt append=true'.

Field Summary

static String	ATTRIBUTE_ALLOWED_VALUES Attribute of returned Value property descriptors listing recognized values for the property.
static String	ATTRIBUTE_CATEGORY Attribute of the returned Value property descriptors naming the property' hierarchical category.
static String	ATTRIBUTE_ORDER Attribute of the returned Value property descriptors naming the property's ordering in its category.
static String	ATTRIBUTE_TYPE Attribute of the returned Value property descriptors naming the property's type or category.

Fields inherited from interface java.beans.BeanInfo

ICON_COLOR_16x16, ICON_COLOR_32x32, ICON_MONO_16x16, ICON_MONO_32x32

Method Summary

void	addPropertyChangeListener(PropertyChangeListener listener) Adds a listener for any property changes.
void	close() Free the resources used by this object.
void	fromProperties(Properties properties) Set this Configuration via the given Properties.
RuntimeException	getConfigurationException(String msg, Throwable cause) Return an appropriate exception indicating a configuration error.
Log	getConfigurationLog() Return the log to use for configuration messages.
Log	getLog(String category) Return the log for the given category.
LogFactory	getLogFactory() The log factory.
Value	getValue(String property) Return a Value for a given property.
Value[]	getValues() Return the set of all Values.
boolean	isCaching() Return whether Properties conversions are cached.
boolean	isFrozen() Return true if this Configuration has been frozen.
void	removePropertyChangeListener(PropertyChangeListener listener) Removes a listener for any property changes.
void	setCaching(boolean cache) Set whether to optimize Properties conversion by caching Value states.
void	setFrozen(boolean frozen) Lock down the configuration's state.
void	setLogFactory(LogFactory factory) log factory.
Properties	toProperties() A Properties representation of this Configuration.
Properties	toProperties(boolean storeDefaults) A Properties representation of this Configuration.

Methods inherited from interface java.beans.BeanInfo

getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getIcon, getMethodDescriptors, getPropertyDescriptors

Field Detail

ATTRIBUTE_ALLOWED_VALUES

public static final String ATTRIBUTE_ALLOWED_VALUES

Attribute of returned Value property descriptors listing recognized values for the property.

ATTRIBUTE_TYPE

public static final String ATTRIBUTE_TYPE

Attribute of the returned Value property descriptors naming the property's type or category.

ATTRIBUTE_CATEGORY

public static final String ATTRIBUTE_CATEGORY

Attribute of the returned Value property descriptors naming the property' hierarchical category.

ATTRIBUTE_ORDER

public static final String ATTRIBUTE_ORDER

Attribute of the returned Value property descriptors naming the property's ordering in its category.

Method Detail

getLogFactory

public LogFactory getLogFactory()

The log factory. If no log factory has been set explicitly, this method will create one.

setLogFactory

public void setLogFactory(LogFactory factory)

log factory.

getConfigurationLog

public Log getConfigurationLog()

Return the log to use for configuration messages.

getLog

public Log getLog(String category)

Return the log for the given category.

See Also:

getLogFactory()

getValue

public Value getValue(String property)

Return a Value for a given property.

getValues

public Value[] getValues()

Return the set of all Values.

setCaching

public void setCaching(boolean cache)

Set whether to optimize Properties conversion by caching Value states.

isCaching

public boolean isCaching()

Return whether Properties conversions are cached.

setFrozen

public void setFrozen(boolean frozen)

Lock down the configuration's state. Attempting to set state after a configuration has been frozen results in a IllegalStateException.

isFrozen

public boolean isFrozen()

Return true if this Configuration has been frozen.

toProperties

public Properties toProperties()

A Properties representation of this Configuration. Note that changes made to this Properties object will not be automatically reflected in this Configuration object.

toProperties

public Properties toProperties(boolean storeDefaults)

A Properties representation of this Configuration. Note that changes made to this Properties object will not be automatically reflected in this Configuration object.

Parameters:

storeDefaults - if true, then properties will be written out even if they match the default value for a property

fromProperties

public void fromProperties(Properties properties)

Set this Configuration via the given Properties. Any keys missing from the given properties will not be set. Note that changes made to this Properties object will not be automatically reflected in this Configuration object.

close

public void close()

Free the resources used by this object.

Specified by:

close in interface com.solarmetric.util.Closeable

getConfigurationException

public RuntimeException getConfigurationException(String msg,
                                                  Throwable cause)

Return an appropriate exception indicating a configuration error. The given cause may be null.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener listener)

Adds a listener for any property changes.

Parameters:

listener - the listener to receive notification of property changes

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener listener)

Removes a listener for any property changes.

Parameters:

listener - the listener to remove