|
SolarMetric Kodo JDO 3.1.6 generated on August 25 2004 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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_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 |
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 Value s. |
boolean |
isCaching()
Return whether Properties conversions are cached. |
boolean |
isFrozen()
Return true if this Configuration has been frozen. |
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. |
Methods inherited from interface java.beans.BeanInfo |
getAdditionalBeanInfo, getBeanDescriptor, getDefaultEventIndex, getDefaultPropertyIndex, getEventSetDescriptors, getIcon, getMethodDescriptors, getPropertyDescriptors |
Field Detail |
public static final String ATTRIBUTE_ALLOWED_VALUES
Value
property descriptors listing
recognized values for the property.public static final String ATTRIBUTE_TYPE
Value
property descriptors naming
the property's type or category.Method Detail |
public LogFactory getLogFactory()
public void setLogFactory(LogFactory factory)
public Log getConfigurationLog()
public Log getLog(String category)
getLogFactory()
public Value getValue(String property)
Value
for a given property.public Value[] getValues()
Value
s.public void setCaching(boolean cache)
Properties
conversion
by caching Value
states.public boolean isCaching()
Properties
conversions are cached.public void setFrozen(boolean frozen)
IllegalStateException
.public boolean isFrozen()
public Properties toProperties()
public void fromProperties(Properties properties)
public void close()
close
in interface com.solarmetric.util.Closeable
public RuntimeException getConfigurationException(String msg, Throwable cause)
|
SolarMetric Kodo JDO 3.1.6 generated on August 25 2004 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |