Package net.toddm.comm

Interface ConfigurationProvider

All Known Implementing Classes:

DefaultConfigurationProvider, MapConfigurationProvider

public interface ConfigurationProvider

Configuration providers implement this interface in order to expose configuration data to the comm framework.

Author:

Todd S. Murchison

Method Summary

Modifier and Type	Method	Description
boolean	contains(String name)	Returns true if a value with the given name exists in the configuration data, false otherwise.
Object	get(String name)	Returns an Object representation of the configuration value with the given name.
boolean	getBoolean(String name)	Returns a boolean representation of the configuration value with the given name.
int	getInt(String name)	Returns an integer representation of the configuration value with the given name.
long	getLong(String name)	Returns a long representation of the configuration value with the given name.
String	getString(String name)	Returns a String representation of the configuration value with the given name.

Method Detail

contains

boolean contains(String name)

Returns true if a value with the given name exists in the configuration data, false otherwise.

get

Object get(String name)
    throws ConfigurationException

Returns an Object representation of the configuration value with the given name. If no such value exists a ConfigurationException is thrown.

Throws:

ConfigurationException

getString

String getString(String name)
          throws ConfigurationException

Returns a String representation of the configuration value with the given name. If no such value exists or the value can not be interpreted as a String a ConfigurationException is thrown.

Throws:

ConfigurationException

getInt

int getInt(String name)
    throws ConfigurationException

Returns an integer representation of the configuration value with the given name. If no such value exists or the value can not be interpreted as an int a ConfigurationException is thrown.

Throws:

ConfigurationException

getLong

long getLong(String name)
      throws ConfigurationException

Returns a long representation of the configuration value with the given name. If no such value exists or the value can not be interpreted as a long a ConfigurationException is thrown.

Throws:

ConfigurationException

getBoolean

boolean getBoolean(String name)
            throws ConfigurationException

Returns a boolean representation of the configuration value with the given name. If no such value exists or the value can not be interpreted as a boolean a ConfigurationException is thrown.

Throws:

ConfigurationException