Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

org.apache.slide.util.conf
Interface Configuration

All Known Implementing Classes:
AbstractConfiguration
public interface Configuration

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.

Version:
1.1.0, 22/05/1999.
Author:
Federico Barbieri, Pierpaolo Fumagalli, Stefano Mazzocchi, Berin Loritsch, Java Apache Project

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 getAttributeAsInt(java.lang.String paramName)
          Return the int value of the specified attribute contained in this node.
 int getAttributeAsInt(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.
 Configuration getConfiguration(java.lang.String child)
          Return a new Configuration instance encapsulating the specified child node.
 java.util.Enumeration getConfigurations(java.lang.String name)
          Return an Enumeration of Configuration elements containing all node children with the specified name.
 java.lang.String getLocation()
          Return a String indicating the position of this configuration element in a source file or URI.
 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 getValueAsInt()
          Return the int value of the node.
 int getValueAsInt(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

getName

public java.lang.String getName()
Return the name of the node.

getConfiguration

public Configuration getConfiguration(java.lang.String child)
                               throws ConfigurationException
Return a new Configuration instance encapsulating the specified child node.
Parameters:
child - The name of the child node.
Throws:
ConfigurationException - If no child with that name exists.

getConfigurations

public java.util.Enumeration getConfigurations(java.lang.String name)
Return an Enumeration of Configuration elements containing all node children with the specified name.
Parameters:
name - The name of the children to get.

getAttribute

public java.lang.String getAttribute(java.lang.String paramName)
                              throws ConfigurationException
Return the value of specified attribute.
Parameters:
paramName - The name of the parameter you ask the value of.
Throws:
ConfigurationException - If no attribute with that name exists.

getAttributeAsInt

public int getAttributeAsInt(java.lang.String paramName)
                      throws ConfigurationException
Return the int value of the specified attribute contained in this node.
Parameters:
paramName - The name of the parameter you ask the value of.
Throws:
ConfigurationException - If no parameter with that name exists. or if conversion to int fails.

getAttributeAsLong

public long getAttributeAsLong(java.lang.String name)
                        throws ConfigurationException
Returns the value of the attribute specified by its name as a long.
Parameters:
paramName - The name of the parameter you ask the value of.
Throws:
ConfigurationException - If no parameter with that name exists. or if conversion to long fails.

getAttributeAsFloat

public float getAttributeAsFloat(java.lang.String paramName)
                          throws ConfigurationException
Return the float value of the specified parameter contained in this node.
Parameters:
paramName - The name of the parameter you ask the value of.
Throws:
ConfigurationException - If no parameter with that name exists. or if conversion to float fails.

getAttributeAsBoolean

public boolean getAttributeAsBoolean(java.lang.String paramName)
                              throws ConfigurationException
Return the boolean value of the specified parameter contained in this node.
Parameters:
paramName - The name of the parameter you ask the value of.
Throws:
ConfigurationException - If no parameter with that name exists. or if conversion to boolean fails.

getValue

public java.lang.String getValue()
Return the String value of the node.

getValueAsInt

public int getValueAsInt()
                  throws ConfigurationException
Return the int value of the node.
Throws:
ConfigurationException - If conversion to int fails.

getValueAsFloat

public float getValueAsFloat()
                      throws ConfigurationException
Return the float value of the node.
Throws:
ConfigurationException - If conversion to float fails.

getValueAsBoolean

public boolean getValueAsBoolean()
                          throws ConfigurationException
Return the boolean value of the node.
Throws:
ConfigurationException - If conversion to boolean fails.

getValueAsLong

public long getValueAsLong()
                    throws ConfigurationException
Return the long value of the node.
Throws:
ConfigurationException - If conversion to long fails.

getValue

public java.lang.String getValue(java.lang.String defaultValue)
Returns the value of the configuration element as a String. If the configuration value is not set, the default value will be used.
Parameters:
defaultValue - The default value desired.

getValueAsInt

public int getValueAsInt(int defaultValue)
Returns the value of the configuration element as an int. If the configuration value is not set, the default value will be used.
Parameters:
defaultValue - The default value desired.

getValueAsLong

public long getValueAsLong(long defaultValue)
Returns the value of the configuration element as a long. If the configuration value is not set, the default value will be used.
Parameters:
defaultValue - The default value desired.

getValueAsFloat

public float getValueAsFloat(float defaultValue)
Returns the value of the configuration element as a float. If the configuration value is not set, the default value will be used.
Parameters:
defaultValue - The default value desired.

getValueAsBoolean

public boolean getValueAsBoolean(boolean defaultValue)
Returns the value of the configuration element as a boolean. If the configuration value is not set, the default value will be used.
Parameters:
defaultValue - The default value desired.

getAttribute

public 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.
Parameters:
name - The name of the attribute you ask the value of.
defaultValue - The default value desired.

getAttributeAsInt

public int getAttributeAsInt(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.
Parameters:
name - The name of the attribute you ask the value of.
defaultValue - The default value desired.

getAttributeAsLong

public 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.
Parameters:
name - The name of the attribute you ask the value of.
defaultValue - The default value desired.

getAttributeAsFloat

public 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.
Parameters:
name - The name of the attribute you ask the value of.
defaultValue - The default value desired.

getAttributeAsBoolean

public 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.
Parameters:
name - The name of the attribute you ask the value of.
defaultValue - The default value desired.

getLocation

public java.lang.String getLocation()
Return a String indicating the position of this configuration element in a source file or URI.
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD