|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Configuration
Interface for generic configuration objects. Includes the ability
to write configuration to and from Properties
instances. Instances
are threadsafe for reads, but not for writes.
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_INTERFACE
Attribute of the returned Value property descriptors naming
the interface that plugin values for this property must implement. |
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. |
static String |
ATTRIBUTE_XML
Attribute of the returned Value property descriptors naming
the property's name in XML format (i.e. |
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. |
Value |
addValue(Value val)
Add the given value to the set of configuration properties. |
Object |
clone()
Return a copy of this configuration. |
void |
close()
Free the resources used by this object. |
void |
fromProperties(Map map)
Set this Configuration via the given map. |
Log |
getConfigurationLog()
Return the log to use for configuration messages. |
Value[] |
getDynamicValues()
Gets the values that can be modified dynamically i.e. |
String |
getId()
An environment-specific identifier for this configuration. |
String |
getLog()
Log plugin setting. |
Log |
getLog(String category)
Return the log for the given category. |
LogFactory |
getLogFactory()
The log factory. |
String |
getProductName()
Return the product name. |
Value |
getValue(String property)
Return the Value for the given property, or null if none. |
Value[] |
getValues()
Return the set of all Value s. |
void |
instantiateAll()
Call the instantiating get methods for all values. |
boolean |
isDynamic(String property)
Affirms if the given property can be modified dynamically i.e. |
boolean |
isReadOnly()
Return true if this configuration is immutable. |
void |
modifyDynamic(String property,
Object newValue)
Modifies a dynamic property of this receiver even when frozen . |
void |
removePropertyChangeListener(PropertyChangeListener listener)
Removes a listener for any property changes. |
boolean |
removeValue(Value val)
Remove the given value from the set of configuration properties. |
void |
setId(String id)
An environment-specific identifier for this configuration. |
void |
setLog(String log)
Log plugin setting. |
void |
setLogFactory(LogFactory factory)
The log factory. |
void |
setProductName(String name)
Set the product name. |
void |
setReadOnly(boolean readOnly)
Lock down the configuration's state. |
Map |
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 |
---|
static final String ATTRIBUTE_ALLOWED_VALUES
Value
property descriptors listing
recognized values for the property.
static final String ATTRIBUTE_TYPE
Value
property descriptors naming
the property's type or category.
static final String ATTRIBUTE_CATEGORY
Value
property descriptors naming
the property' hierarchical category.
static final String ATTRIBUTE_ORDER
Value
property descriptors naming
the property's ordering in its category.
static final String ATTRIBUTE_INTERFACE
Value
property descriptors naming
the interface that plugin values for this property must implement.
static final String ATTRIBUTE_XML
Value
property descriptors naming
the property's name in XML format (i.e. two-words instead of TwoWords).
Method Detail |
---|
String getProductName()
openjpa
.
void setProductName(String name)
LogFactory getLogFactory()
void setLogFactory(LogFactory factory)
String getLog()
void setLog(String log)
Log getLog(String category)
getLogFactory()
Log getConfigurationLog()
String getId()
void setId(String id)
Value getValue(String property)
Value
for the given property, or null if none.
Value[] getValues()
Value
s.
Value addValue(Value val)
boolean removeValue(Value val)
Map toProperties(boolean storeDefaults)
storeDefaults
- if true, then properties will be written
out even if they match the default value for a propertyvoid fromProperties(Map map)
equals
and
hashCode
methods. If the object's property has no
string form(such as an ObjectValue
), the object is not
part of the equality and hashing calculations.
void addPropertyChangeListener(PropertyChangeListener listener)
listener
- the listener to receive notification of property changesvoid removePropertyChangeListener(PropertyChangeListener listener)
listener
- the listener to removevoid setReadOnly(boolean readOnly)
boolean isReadOnly()
void instantiateAll()
void close()
close
in interface Closeable
Object clone()
void modifyDynamic(String property, Object newValue)
frozen
.
boolean isDynamic(String property)
frozen
.
Value[] getDynamicValues()
frozen
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |