|
Celtix User APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Configuration
Method Summary | ||
---|---|---|
boolean |
getBoolean(String name)
Convenience method to extract the value of a boolean type configuration item from its holder object. |
|
Configuration |
getChild(String namespaceURI,
Object id)
Returns the child configuration of the type specified in the namespaceURI and with the specified identifier if there is one, otherwise null. |
|
double |
getDouble(String name)
Convenience method to extract the value of a double type configuration item from its holder object. |
|
float |
getFloat(String name)
Convenience method to extract the value of a float type configuration item from its holder object. |
|
Object |
getId()
Returns the identifier for this configuration instance (unique within all instances configuration instances for the same metadata model). |
|
int |
getInt(String name)
Convenience method to extract the value of an int type configuration item from its holder object. |
|
long |
getLong(String name)
Convenience method to extract the value of a long type configuration item from its holder object. |
|
ConfigurationMetadata |
getModel()
Returns the configuration metadata model for this Configuration . |
|
|
getObject(Class<T> cls,
String name)
Returns the object holding the value for the configuration item with the specified name. |
|
Object |
getObject(String name)
Returns the object holding the value for the configuration item with the specified name. |
|
Configuration |
getParent()
Returns the parent configuration of this configuration, or null if there is no parent. |
|
List<ConfigurationProvider> |
getProviders()
Returns the list of configuration providers for this configuration. |
|
short |
getShort(String name)
Convenience method to extract the value of a short type configuration item from its holder object. |
|
String |
getString(String name)
Convenience method to extract the value of a string type configuration item from its holder object. |
|
List<String> |
getStringList(String name)
Convenience method to extract the value of a string list type configuration item from its holder object. |
|
void |
setProviders(List<ConfigurationProvider> providers)
Sets the list of configuration providers for this configuration - these will be consulted in orde when looking up the value for a particular configuration item. |
Method Detail |
---|
Object getId()
ConfigurationMetadata getModel()
Configuration
.
void setProviders(List<ConfigurationProvider> providers)
providers
- the configuration providers to use for this configuration.List<ConfigurationProvider> getProviders()
Configuration getParent()
Configuration getChild(String namespaceURI, Object id)
id
- the identifier of the child configuration.
Object getObject(String name)
name
- the name of the configuration item.
ConfigurationException
- if no such item is defined in this configuration's
metadata model, or if no value for this item can be found in either this configuration
or any of its parent configuration's and if no default value is specified for the
item in the metadata model.<T> T getObject(Class<T> cls, String name)
name
- the name of the configuration item.cls
- the class of the configuration item.
ConfigurationException
- if no such item is defined in this configuration's
metadata model, or if no value for this item can be found in either this configuration
or any of its parent configuration's and if no default value is specified for the
item in the metadata model.boolean getBoolean(String name)
name
- the name of the configuration item.
short getShort(String name)
name
- the name of the configuration item.
int getInt(String name)
name
- the name of the configuration item.
long getLong(String name)
name
- the name of the configuration item.
float getFloat(String name)
name
- the name of the configuration item.
double getDouble(String name)
name
- the name of the configuration item.
String getString(String name)
name
- the name of the configuration item.
List<String> getStringList(String name)
name
- the name of the configuration item.
|
Celtix User APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |