Package net.officefloor.configuration

Interface ConfigurationContext

All Known Subinterfaces:

OfficeExtensionContext, OfficeFloorExtensionContext, OfficeFloorSourceContext, OfficeSourceContext, SectionSourceContext, WoofTemplateExtensionSourceContext, WritableConfigurationContext

All Known Implementing Classes:

AbstractWritableConfigurationContext, ClassLoaderConfigurationContext, ConfigurationContextImpl, ConfigurationSourceContextImpl, FileSystemConfigurationContext, MemoryConfigurationContext, OfficeFloorSourceContextImpl, OfficeSourceContextImpl, ProjectConfigurationContext, SectionSourceContextImpl, XmlFileConfigurationContext

public interface ConfigurationContext

Context of the ConfigurationItem instances.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEFAULT_TAG_PREFIX	Default tag prefix.
static java.lang.String	DEFAULT_TAG_SUFFIX	Default tag suffix.
static java.lang.String	PROPERTY_CONFIGURATION_INPUT_CHARSET	Name of the Property containing the Charset to use for the ConfigurationItem Reader.
static java.lang.String	PROPERTY_CONFIGURATION_INPUT_TAG_PREFIX	Name of Property containing the prefix of the tag name.
static java.lang.String	PROPERTY_CONFIGURATION_INPUT_TAG_SUFFIX	Name of Property containing the suffix of the tag name.
static java.lang.String	PROPERTY_CONFIGURATION_OUTPUT_CHARSET	Charset to use for the InputStream for the ConfigurationItem.

Method Summary

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

Field Detail

PROPERTY_CONFIGURATION_INPUT_CHARSET

static final java.lang.String PROPERTY_CONFIGURATION_INPUT_CHARSET

Name of the Property containing the Charset to use for the ConfigurationItem Reader. Should this not be specified, the Charset.defaultCharset() will be used.

See Also:

Constant Field Values

PROPERTY_CONFIGURATION_INPUT_TAG_PREFIX

static final java.lang.String PROPERTY_CONFIGURATION_INPUT_TAG_PREFIX

Name of Property containing the prefix of the tag name.

See Also:

Constant Field Values

DEFAULT_TAG_PREFIX

static final java.lang.String DEFAULT_TAG_PREFIX

Default tag prefix.

See Also:

Constant Field Values

PROPERTY_CONFIGURATION_INPUT_TAG_SUFFIX

static final java.lang.String PROPERTY_CONFIGURATION_INPUT_TAG_SUFFIX

Name of Property containing the suffix of the tag name.

See Also:

Constant Field Values

DEFAULT_TAG_SUFFIX

static final java.lang.String DEFAULT_TAG_SUFFIX

Default tag suffix.

See Also:

Constant Field Values

PROPERTY_CONFIGURATION_OUTPUT_CHARSET

static final java.lang.String PROPERTY_CONFIGURATION_OUTPUT_CHARSET

Charset to use for the InputStream for the ConfigurationItem. Should this not be specified, the PROPERTY_CONFIGURATION_INPUT_CHARSET will be used (followed by its defaults).

See Also:

Constant Field Values

Method Detail

getConfigurationItem

ConfigurationItem getConfigurationItem(java.lang.String location,
                                       PropertyList overrideProperties)
                                throws UnknownResourceError,
                                       ConfigurationError

Obtains the ConfigurationItem at the location.

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

Parameters:

location - Location of the ConfigurationItem to obtain.

overrideProperties - 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

ConfigurationItem getOptionalConfigurationItem(java.lang.String location,
                                               PropertyList overrideProperties)
                                        throws ConfigurationError

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

Also, undertakes tag replacement from the PropertyList.

Parameters:

location - Location of the ConfigurationItem to obtain.

overrideProperties - 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.