Package net.officefloor.configuration.impl

Class ConfigurationContextImpl

java.lang.Object

net.officefloor.configuration.impl.ConfigurationContextImpl

All Implemented Interfaces:

ConfigurationContext

Direct Known Subclasses:

AbstractWritableConfigurationContext, ClassLoaderConfigurationContext, XmlFileConfigurationContext

public class ConfigurationContextImpl
extends java.lang.Object
implements ConfigurationContext

Abstract ConfigurationContext.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ConfigurationContextImpl.ConfigurationSource	Function interface to obtain the InputStream for the ConfigurationItem.

Field Summary

Fields inherited from interface net.officefloor.configuration.ConfigurationContext

DEFAULT_TAG_PREFIX, DEFAULT_TAG_SUFFIX, PROPERTY_CONFIGURATION_INPUT_CHARSET, PROPERTY_CONFIGURATION_INPUT_TAG_PREFIX, PROPERTY_CONFIGURATION_INPUT_TAG_SUFFIX, PROPERTY_CONFIGURATION_OUTPUT_CHARSET

Constructor Summary

Constructors

Constructor	Description
ConfigurationContextImpl(ConfigurationContextImpl.ConfigurationSource configurationSource, SourceProperties properties)	Instantiate.

Method Summary

Modifier and Type	Method	Description
protected ConfigurationItem	createConfigurationItem(java.lang.String location, byte[] rawConfiguration, java.lang.String configuration, java.nio.charset.Charset charset)	Creates the ConfigurationItem.
ConfigurationItem	getConfigurationItem(java.lang.String location, PropertyList properties)	Obtains the ConfigurationItem at the location.
protected ConfigurationContextImpl.ConfigurationSource	getConfigurationSource()	Obtains the ConfigurationContextImpl.ConfigurationSource.
ConfigurationItem	getOptionalConfigurationItem(java.lang.String location, PropertyList properties)	Obtains the optional ConfigurationItem at the location.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigurationContextImpl

public ConfigurationContextImpl(ConfigurationContextImpl.ConfigurationSource configurationSource,
                                SourceProperties properties)

Instantiate.

Parameters:

configurationSource - ConfigurationContextImpl.ConfigurationSource.

properties - SourceProperties.

Method Detail

getConfigurationSource

protected ConfigurationContextImpl.ConfigurationSource getConfigurationSource()

Obtains the ConfigurationContextImpl.ConfigurationSource.

Returns:

ConfigurationContextImpl.ConfigurationSource.

createConfigurationItem

protected ConfigurationItem createConfigurationItem(java.lang.String location,
                                                    byte[] rawConfiguration,
                                                    java.lang.String configuration,
                                                    java.nio.charset.Charset charset)

Creates the ConfigurationItem.

Provided to enable overriding the creation of the ConfigurationItem.

Parameters:

location - Location of the ConfigurationItem.

rawConfiguration - Raw configuration read from ConfigurationContextImpl.ConfigurationSource.

configuration - Configuration with Property replacement.

charset - Output Charset.

Returns:

ConfigurationItem.

getConfigurationItem

public ConfigurationItem getConfigurationItem(java.lang.String location,
                                              PropertyList properties)

Description copied from interface: ConfigurationContext

Obtains the ConfigurationItem at the location.

Tags within the configuration are replaced by the PropertyList following naming convention ${PropertyName}.

Specified by:

getConfigurationItem in interface ConfigurationContext

Parameters:

location - Location of the ConfigurationItem to obtain.

properties - Override PropertyList for tag replacement. May be null.

Returns:

ConfigurationItem.

getOptionalConfigurationItem

public ConfigurationItem getOptionalConfigurationItem(java.lang.String location,
                                                      PropertyList properties)

Description copied from interface: ConfigurationContext

Obtains the optional ConfigurationItem at the location. May return null if not ConfigurationItem at the location.

Also, undertakes tag replacement from the PropertyList.

Specified by:

getOptionalConfigurationItem in interface ConfigurationContext

Parameters:

location - Location of the ConfigurationItem to obtain.

properties - Override PropertyList for tag replacement. May be null.

Returns:

ConfigurationItem or null if no configuration at location.