|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Configuration
is a interface encapsulating a configuration node
used to retrieve configuration values. This is a "read only" interface
preventing applications from modifying their own configurations.
The contract surrounding the Configuration
is that once
it is created, information never changes. The Configuration
is built by the SAXConfigurationBuilder
and the
ConfigurationImpl
helper classes.
Method Summary | |
java.lang.String |
getAttribute(java.lang.String paramName)
Return the value of specified attribute. |
java.lang.String |
getAttribute(java.lang.String name,
java.lang.String defaultValue)
Returns the value of the attribute specified by its name as a String , or the default value if no attribute by
that name exists or is empty. |
boolean |
getAttributeAsBoolean(java.lang.String paramName)
Return the boolean value of the specified parameter contained
in this node. |
boolean |
getAttributeAsBoolean(java.lang.String name,
boolean defaultValue)
Returns the value of the attribute specified by its name as a boolean , or the default value if no attribute by
that name exists or is empty. |
float |
getAttributeAsFloat(java.lang.String paramName)
Return the float value of the specified parameter contained
in this node. |
float |
getAttributeAsFloat(java.lang.String name,
float defaultValue)
Returns the value of the attribute specified by its name as a float , or the default value if no attribute by
that name exists or is empty. |
int |
getAttributeAsInteger(java.lang.String paramName)
Return the int value of the specified attribute contained
in this node. |
int |
getAttributeAsInteger(java.lang.String name,
int defaultValue)
Returns the value of the attribute specified by its name as a int , or the default value if no attribute by
that name exists or is empty. |
long |
getAttributeAsLong(java.lang.String name)
Returns the value of the attribute specified by its name as a long . |
long |
getAttributeAsLong(java.lang.String name,
long defaultValue)
Returns the value of the attribute specified by its name as a long , or the default value if no attribute by
that name exists or is empty. |
java.lang.String[] |
getAttributeNames()
Return an array of all attribute names. |
Configuration |
getChild(java.lang.String child)
Return a new Configuration instance encapsulating the
specified child node. |
Configuration |
getChild(java.lang.String child,
boolean createNew)
Return a new Configuration instance encapsulating the
specified child node. |
Configuration[] |
getChildren()
Return an Array of Configuration
elements containing all node children. |
Configuration[] |
getChildren(java.lang.String name)
Return an Array of Configuration
elements containing all node children with the specified name. |
java.lang.String |
getLocation()
Return a string describing location of Configuration. |
java.lang.String |
getName()
Return the name of the node. |
java.lang.String |
getValue()
Return the String value of the node. |
java.lang.String |
getValue(java.lang.String defaultValue)
Returns the value of the configuration element as a String . |
boolean |
getValueAsBoolean()
Return the boolean value of the node. |
boolean |
getValueAsBoolean(boolean defaultValue)
Returns the value of the configuration element as a boolean . |
float |
getValueAsFloat()
Return the float value of the node. |
float |
getValueAsFloat(float defaultValue)
Returns the value of the configuration element as a float . |
int |
getValueAsInteger()
Return the int value of the node. |
int |
getValueAsInteger(int defaultValue)
Returns the value of the configuration element as an int . |
long |
getValueAsLong()
Return the long value of the node. |
long |
getValueAsLong(long defaultValue)
Returns the value of the configuration element as a long . |
Method Detail |
public java.lang.String getName()
Configuration
node.public java.lang.String getLocation()
public Configuration getChild(java.lang.String child)
Configuration
instance encapsulating the
specified child node.child
- The name of the child node.public Configuration getChild(java.lang.String child, boolean createNew)
Configuration
instance encapsulating the
specified child node.child
- The name of the child node.public Configuration[] getChildren()
Array
of Configuration
elements containing all node children.public Configuration[] getChildren(java.lang.String name)
Array
of Configuration
elements containing all node children with the specified name.name
- The name of the children to get.public java.lang.String[] getAttributeNames()
public java.lang.String getAttribute(java.lang.String paramName) throws ConfigurationException
paramName
- The name of the parameter you ask the value of.ConfigurationException
- If no attribute with that name exists.public int getAttributeAsInteger(java.lang.String paramName) throws ConfigurationException
int
value of the specified attribute contained
in this node.paramName
- The name of the parameter you ask the value of.ConfigurationException
- If no parameter with that name exists.
or if conversion to int
fails.public long getAttributeAsLong(java.lang.String name) throws ConfigurationException
long
.paramName
- The name of the parameter you ask the value of.ConfigurationException
- If no parameter with that name exists.
or if conversion to long
fails.public float getAttributeAsFloat(java.lang.String paramName) throws ConfigurationException
float
value of the specified parameter contained
in this node.paramName
- The name of the parameter you ask the value of.ConfigurationException
- If no parameter with that name exists.
or if conversion to float
fails.public boolean getAttributeAsBoolean(java.lang.String paramName) throws ConfigurationException
boolean
value of the specified parameter contained
in this node.paramName
- The name of the parameter you ask the value of.ConfigurationException
- If no parameter with that name exists.
or if conversion to boolean
fails.public java.lang.String getValue() throws ConfigurationException
String
value of the node.public int getValueAsInteger() throws ConfigurationException
int
value of the node.ConfigurationException
- If conversion to int
fails.public float getValueAsFloat() throws ConfigurationException
float
value of the node.ConfigurationException
- If conversion to float
fails.public boolean getValueAsBoolean() throws ConfigurationException
boolean
value of the node.ConfigurationException
- If conversion to boolean
fails.public long getValueAsLong() throws ConfigurationException
long
value of the node.ConfigurationException
- If conversion to long
fails.public java.lang.String getValue(java.lang.String defaultValue)
String
.
If the configuration value is not set, the default value will be
used.defaultValue
- The default value desired.Configuration
, or default
if none specified.public int getValueAsInteger(int defaultValue)
int
.
If the configuration value is not set, the default value will be
used.defaultValue
- The default value desired.Configuration
, or default
if none specified.public long getValueAsLong(long defaultValue)
long
.
If the configuration value is not set, the default value will be
used.defaultValue
- The default value desired.Configuration
, or default
if none specified.public float getValueAsFloat(float defaultValue)
float
.
If the configuration value is not set, the default value will be
used.defaultValue
- The default value desired.Configuration
, or default
if none specified.public boolean getValueAsBoolean(boolean defaultValue)
boolean
.
If the configuration value is not set, the default value will be
used.defaultValue
- The default value desired.Configuration
, or default
if none specified.public java.lang.String getAttribute(java.lang.String name, java.lang.String defaultValue)
String
, or the default value if no attribute by
that name exists or is empty.name
- The name of the attribute you ask the value of.defaultValue
- The default value desired.public int getAttributeAsInteger(java.lang.String name, int defaultValue)
int
, or the default value if no attribute by
that name exists or is empty.name
- The name of the attribute you ask the value of.defaultValue
- The default value desired.public long getAttributeAsLong(java.lang.String name, long defaultValue)
long
, or the default value if no attribute by
that name exists or is empty.name
- The name of the attribute you ask the value of.defaultValue
- The default value desired.public float getAttributeAsFloat(java.lang.String name, float defaultValue)
float
, or the default value if no attribute by
that name exists or is empty.name
- The name of the attribute you ask the value of.defaultValue
- The default value desired.public boolean getAttributeAsBoolean(java.lang.String name, boolean defaultValue)
boolean
, or the default value if no attribute by
that name exists or is empty.name
- The name of the attribute you ask the value of.defaultValue
- The default value desired.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |