|
SolarMetric Kodo JDO 3.3.5 generated on August 31 2005 | ||||||||
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.
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 the Value for the given property, or null if none. |
Value[] |
getValues()
Return the set of all Value s. |
boolean |
hasJava5()
Return true if this VM has Java 5 features; otherwise
returns false . |
boolean |
isFrozen()
Return true if this Configuration has been frozen. |
void |
removePropertyChangeListener(PropertyChangeListener listener)
Removes a listener for any property changes. |
void |
setFrozen(boolean frozen)
Lock down the configuration's state. |
void |
setLogFactory(LogFactory factory)
log factory. |
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 |
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.public static final String ATTRIBUTE_CATEGORY
Value
property descriptors naming
the property' hierarchical category.public static final String ATTRIBUTE_ORDER
Value
property descriptors naming
the property's ordering in its category.Method Detail |
public LogFactory getLogFactory()
public void setLogFactory(LogFactory factory)
public Log getLog(String category)
getLogFactory()
public Value getValue(String property)
Value
for the given property, or null if none.public Value[] getValues()
Value
s.public Properties toProperties(boolean storeDefaults)
storeDefaults
- if true, then properties will be written
out even if they match the default value
for a propertypublic void fromProperties(Properties properties)
public void addPropertyChangeListener(PropertyChangeListener listener)
listener
- the listener to receive notification
of property changespublic void removePropertyChangeListener(PropertyChangeListener listener)
listener
- the listener to removepublic void setFrozen(boolean frozen)
IllegalStateException
.public boolean isFrozen()
public void close()
close
in interface com.solarmetric.util.Closeable
public Log getConfigurationLog()
public RuntimeException getConfigurationException(String msg, Throwable cause)
public boolean hasJava5()
true
if this VM has Java 5 features; otherwise
returns false
.
|
SolarMetric Kodo JDO 3.3.5 generated on August 31 2005 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |