Package net.officefloor.configuration.impl

Class ConfigurationSourceContextImpl

java.lang.Object

net.officefloor.frame.impl.construct.source.SourcePropertiesImpl

net.officefloor.frame.impl.construct.source.SourceContextImpl

net.officefloor.configuration.impl.ConfigurationSourceContextImpl

All Implemented Interfaces:

ConfigurationContext, ServiceContext, SourceContext, SourceProperties

Direct Known Subclasses:

OfficeFloorSourceContextImpl, OfficeSourceContextImpl, SectionSourceContextImpl

public class ConfigurationSourceContextImpl
extends SourceContextImpl
implements ConfigurationContext

SourceContext and ConfigurationContext implementation.

Author:

Daniel Sagenschneider

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
ConfigurationSourceContextImpl(String sourceName, boolean isLoadingType, SourceContext delegate, String[] additionalProfiles, SourceProperties sourceProperties)	Instantiate.

Method Summary

Modifier and Type	Method	Description
ConfigurationItem	getConfigurationItem(String location, PropertyList properties)	Obtains the ConfigurationItem at the location.
ConfigurationItem	getOptionalConfigurationItem(String location, PropertyList properties)	Obtains the optional ConfigurationItem at the location.

Methods inherited from class net.officefloor.frame.impl.construct.source.SourceContextImpl

getClassLoader, getClock, getLogger, getName, getOptionalResource, getProfiles, getResource, isLoadingType, loadClass, loadOptionalClass, loadOptionalService, loadOptionalServices, loadService, loadService, loadServices

Methods inherited from class net.officefloor.frame.impl.construct.source.SourcePropertiesImpl

addProperty, getProperties, getProperty, getProperty, getPropertyNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.frame.api.source.SourceProperties

getProperties, getProperty, getProperty, getPropertyNames

Constructor Details

ConfigurationSourceContextImpl

public ConfigurationSourceContextImpl(String sourceName,
 boolean isLoadingType,
 SourceContext delegate,
 String[] additionalProfiles,
 SourceProperties sourceProperties)

Instantiate.

Parameters:

sourceName - Name of source.

isLoadingType - Indicates if loading type.

delegate - Delegate SourceContext.

additionalProfiles - Additional profiles.

sourceProperties - SourceProperties.

Method Details

getConfigurationItem

public ConfigurationItem getConfigurationItem(String location,
 PropertyList properties)
                                       throws UnknownResourceError,
ConfigurationError

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.

Throws:

UnknownResourceError - Let this propagate to let OfficeFloor handle the ConfigurationItem not available at the location.

ConfigurationError - Let this propagate to let OfficeFloor handle failure in loading ConfigurationItem.

getOptionalConfigurationItem

public ConfigurationItem getOptionalConfigurationItem(String location,
 PropertyList properties)
                                               throws ConfigurationError

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.

Throws:

ConfigurationError - Let this propagate to let OfficeFloor handle failure in loading ConfigurationItem.