avail/avail.utility.configuration

Package-level declarations

Types

interface Configuration

A Configuration encapsulates the configurable parameters of a software component.

ConfigurationException

class ConfigurationException : Exception

A ConfigurationException is thrown when a configurator fails to functionType a configuration for any reason.

interface Configurator<ConfigurationType : Configuration>

A Configurator produces a configuration tuple information provided during construction of a concrete implementation.

XMLConfigurator

class XMLConfigurator<ConfigurationType : Configuration, ElementType : Enum<ElementType>, XMLElement<ConfigurationType, ElementType, StateType>, StateType : XMLConfiguratorState<ConfigurationType, ElementType, StateType>>(val configuration: ConfigurationType, val state: StateType, elementClass: Class<ElementType>, documentStream: InputStream) : Configurator<ConfigurationType>

An XMLConfigurator obtains a configuration by processing an XML document.

XMLConfiguratorState

class XMLConfiguratorState<ConfigurationType : Configuration, ElementType : Enum<ElementType>, XMLElement<ConfigurationType, ElementType, StateType>, StateType : XMLConfiguratorState<ConfigurationType, ElementType, StateType>>(configuration: ConfigurationType)

An XMLConfiguratorState encapsulates the state of an XMLConfigurator.

XMLDocumentModel

class XMLDocumentModel<ConfigurationType : Configuration, ElementType : Enum<ElementType>, XMLElement<ConfigurationType, ElementType, StateType>, StateType : XMLConfiguratorState<ConfigurationType, ElementType, StateType>>

An XMLConfigurator relies on an XMLDocumentModel to provide a schematic description of the class of XML documents supported by a particular XMLElement implementation. It offers:

interface XMLElement<ConfigurationType : Configuration, ElementType : Enum<ElementType>, XMLElement<ConfigurationType, ElementType, StateType>, StateType : XMLConfiguratorState<ConfigurationType, ElementType, StateType>>

XMLElement is designed to be implemented only by enumerations that represent XML tag sets. Concrete implementations specify the complete set of behavior required to use the XMLConfigurator to produce application-specific configurations.