net.officefloor.model.impl.repository.filesystem

Class FileSystemConfigurationItem

java.lang.Object

net.officefloor.model.impl.repository.filesystem.FileSystemConfigurationItem

All Implemented Interfaces:

ConfigurationItem

public class FileSystemConfigurationItem
extends Object
implements ConfigurationItem

File system ConfigurationItem.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
FileSystemConfigurationItem(File file) Initiate.
FileSystemConfigurationItem(File file, ConfigurationContext configurationContext) Initiate.
FileSystemConfigurationItem(String location, File file, ConfigurationContext configurationContext) Initiate.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemConfigurationItem

public FileSystemConfigurationItem(File file)
                            throws IOException

Initiate.

Parameters:

file - File containing the configuration.

Throws:

IOException - If fails to initialise.

FileSystemConfigurationItem

public FileSystemConfigurationItem(File file,
                                   ConfigurationContext configurationContext)
                            throws IOException

Initiate.

Parameters:

file - File containing the configuration.

configurationContext - ConfigurationContext.

Throws:

IOException - If fails to initialise.

FileSystemConfigurationItem

public FileSystemConfigurationItem(String location,
                                   File file,
                                   ConfigurationContext configurationContext)

Initiate.

Parameters:

location - Relative location of the File within the ConfigurationContext.

file - File containing the configuration.

configurationContext - ConfigurationContext.

Method Detail

getFile

public File getFile()

Obtains the underlying File.

Returns:

Underlying File.

getLocation

public String getLocation()

Description copied from interface: ConfigurationItem

Obtains the relative location for this ConfigurationItem within its ConfigurationContext.

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

Specified by:

getLocation in interface ConfigurationItem

Returns:

Relative location for this ConfigurationItem within its ConfigurationContext.

getContext

public ConfigurationContext getContext()

Description copied from interface: ConfigurationItem

Obtains the ConfigurationContext for this ConfigurationItem.

Specified by:

getContext in interface ConfigurationItem

Returns:

ConfigurationContext for this ConfigurationItem.

getConfiguration

public InputStream getConfiguration()
                             throws Exception

Description copied from interface: ConfigurationItem

Obtains the configuration that this represents.

Specified by:

getConfiguration in interface ConfigurationItem

Returns:

Configuration.

Throws:

Exception - If fails to obtain the configuration.

setConfiguration

public void setConfiguration(InputStream configuration)
                      throws Exception

Description copied from interface: ConfigurationItem

Specifies the configuration that this is to represent.

Specified by:

setConfiguration in interface ConfigurationItem

Parameters:

configuration - Configuration.

Throws:

Exception - If fails to set the configuration.

ReadOnlyConfigurationException - Should the configuration be read-only.