net.officefloor.model.repository

Interface ConfigurationItem

All Known Implementing Classes:

ClassLoaderConfigurationItem, FileConfigurationItem, FileSystemConfigurationItem, InputStreamConfigurationItem, MemoryConfigurationItem, XmlConfigurationItem

public interface ConfigurationItem

Item of configuration within a ConfigurationContext.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
InputStream	getConfiguration() Obtains the configuration that this represents.
ConfigurationContext	getContext() Obtains the ConfigurationContext for this ConfigurationItem.
String	getLocation() Obtains the relative location for this ConfigurationItem within its ConfigurationContext.
void	setConfiguration(InputStream configuration) Specifies the configuration that this is to represent.

Method Detail

getLocation

String getLocation()

Obtains the relative location for this ConfigurationItem within its ConfigurationContext.

This value is used in the equality of ConfigurationItem instances within the ConfigurationContext.

Returns:

Relative location for this ConfigurationItem within its ConfigurationContext.

getConfiguration

InputStream getConfiguration()
                      throws Exception

Obtains the configuration that this represents.

Returns:

Configuration.

Throws:

Exception - If fails to obtain the configuration.

setConfiguration

void setConfiguration(InputStream configuration)
               throws Exception,
                      ReadOnlyConfigurationException

Specifies the configuration that this is to represent.

Parameters:

configuration - Configuration.

Throws:

Exception - If fails to set the configuration.

ReadOnlyConfigurationException - Should the configuration be read-only.

getContext

ConfigurationContext getContext()

Obtains the ConfigurationContext for this ConfigurationItem.

Returns:

ConfigurationContext for this ConfigurationItem.