net.officefloor.model.repository

Interface ConfigurationContext

All Known Implementing Classes:

ClassLoaderConfigurationContext, FileSystemConfigurationContext, MemoryConfigurationContext, ProjectConfigurationContext, XmlConfigurationContext

public interface ConfigurationContext

Context of the ConfigurationItem instances.

Author:

Daniel Sagenschneider

Method Summary

Modifier and Type	Method and Description
ConfigurationItem	createConfigurationItem(String relativeLocation, InputStream configuration) Creates a new ConfigurationItem at the relative location.
void	deleteConfigurationItem(String relativeLocation) Deletes the ConfigurationItem at the relative location.
ConfigurationItem	getConfigurationItem(String relativeLocation) Obtains the ConfigurationItem at the relative location.
String	getLocation() Obtains the location for this ConfigurationContext.
boolean	isReadOnly() Indicates if the configuration is read-only.

Method Detail

getLocation

String getLocation()

Obtains the location for this ConfigurationContext.

This value is used in the equality of ConfigurationContext instances.

Returns:

Location for this ConfigurationContext.

getConfigurationItem

ConfigurationItem getConfigurationItem(String relativeLocation)
                                throws Exception

Obtains the ConfigurationItem at the relative location.

Parameters:

relativeLocation - Relative location of the ConfigurationItem to obtain.

Returns:

ConfigurationItem.

Throws:

Exception - If can not obtain a ConfigurationItem at the relative location.

isReadOnly

boolean isReadOnly()

Indicates if the configuration is read-only.

Returns:

true should the configuration be read-only.

createConfigurationItem

ConfigurationItem createConfigurationItem(String relativeLocation,
                                          InputStream configuration)
                                   throws Exception,
                                          ReadOnlyConfigurationException

Creates a new ConfigurationItem at the relative location.

Parameters:

relativeLocation - Relative location of the ConfigurationItem to create.

configuration - Configuration for the ConfigurationItem.

Returns:

The created ConfigurationItem.

Throws:

Exception - If fails to create the ConfigurationItem.

ReadOnlyConfigurationException - Should the underlying implementation be read-only.

deleteConfigurationItem

void deleteConfigurationItem(String relativeLocation)
                      throws Exception,
                             ReadOnlyConfigurationException

Deletes the ConfigurationItem at the relative location.

Parameters:

relativeLocation - Relative location of the ConfigurationItem to delete.

Throws:

Exception - If can not delete the ConfigurationItem at the relative location.

ReadOnlyConfigurationException - Should the underlying implementation be read-only.