Package net.officefloor.configuration

Interface WritableConfigurationContext

All Superinterfaces:

ConfigurationContext

All Known Implementing Classes:

AbstractWritableConfigurationContext, FileSystemConfigurationContext, MemoryConfigurationContext

public interface WritableConfigurationContext
extends ConfigurationContext

Writable ConfigurationContext.

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

Method Summary

Modifier and Type	Method	Description
WritableConfigurationItem	createConfigurationItem(String location, InputStream configuration)	Creates a new WritableConfigurationItem at the relative location.
void	deleteConfigurationItem(String location)	Deletes the WritableConfigurationItem at the relative location.
WritableConfigurationItem	getWritableConfigurationItem(String location)	Obtains the WritableConfigurationItem at the location.

Methods inherited from interface net.officefloor.configuration.ConfigurationContext

getConfigurationItem, getOptionalConfigurationItem

Method Details

getWritableConfigurationItem

WritableConfigurationItem getWritableConfigurationItem(String location)
                                                throws IOException

Obtains the WritableConfigurationItem at the location.

Parameters:

location - Location of the WritableConfigurationItem to obtain.

Returns:

WritableConfigurationItem.

Throws:

IOException - If can not obtain a WritableConfigurationItem at the location.

createConfigurationItem

WritableConfigurationItem createConfigurationItem(String location,
 InputStream configuration)
                                           throws IOException

Creates a new WritableConfigurationItem at the relative location.

Parameters:

location - Location of the WritableConfigurationItem to create.

configuration - Configuration for the WritableConfigurationItem.

Returns:

The created WritableConfigurationItem.

Throws:

IOException - If fails to create the WritableConfigurationItem.

deleteConfigurationItem

void deleteConfigurationItem(String location)
                      throws IOException

Deletes the WritableConfigurationItem at the relative location.

Parameters:

location - Location of the WritableConfigurationItem to delete.

Throws:

IOException - If can not delete the WritableConfigurationItem at the relative location.