net.officefloor.eclipse.repository.project

Class FileConfigurationItem

java.lang.Object

net.officefloor.eclipse.repository.project.FileConfigurationItem

All Implemented Interfaces:

ConfigurationItem

public class FileConfigurationItem
extends Object
implements ConfigurationItem

Implementation of ConfigurationItem for a IFile.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
FileConfigurationItem(org.eclipse.ui.IEditorInput editorInput) Convenience constructor for use by IEditorPart.
FileConfigurationItem(org.eclipse.ui.IEditorInput editorInput, org.eclipse.core.runtime.IProgressMonitor monitor) Convenience constructor for use by IEditorPart.
FileConfigurationItem(org.eclipse.core.resources.IFile file) Initiate with the IFile containing the configuration.
FileConfigurationItem(org.eclipse.core.resources.IFile file, org.eclipse.core.runtime.IProgressMonitor monitor) Initiate with the IFile containing the configuration and the IProgressMonitor.

Method Summary

Modifier and Type	Method and Description
InputStream	getConfiguration() Obtains the configuration that this represents.
ConfigurationContext	getContext() Obtains the ConfigurationContext for this ConfigurationItem.
org.eclipse.core.resources.IFile	getFile() Returns the underlying file.
static org.eclipse.core.resources.IFile	getFile(AbstractOfficeFloorEditPart<?,?,?> editPart) Convenience method to obtain the IFile for the AbstractOfficeFloorEditPart.
static org.eclipse.core.resources.IFile	getFile(org.eclipse.ui.IEditorInput editorInput) Obtains the IFile from the input IEditorInput.
String	getFileName() Obtains the name of the underlying file.
String	getLocation() Obtains the relative location for this ConfigurationItem within its ConfigurationContext.
static org.eclipse.core.resources.IProject	getProject(AbstractOfficeFloorEditPart<?,?,?> editPart) Convenience method to obtain the IProject for the AbstractOfficeFloorEditPart.
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

FileConfigurationItem

public FileConfigurationItem(org.eclipse.core.resources.IFile file)

Initiate with the IFile containing the configuration.

Parameters:

file - IFile containing configuration.

FileConfigurationItem

public FileConfigurationItem(org.eclipse.ui.IEditorInput editorInput)

Convenience constructor for use by IEditorPart.

Parameters:

editorInput - IEditorInput for the IEditorPart.

FileConfigurationItem

public FileConfigurationItem(org.eclipse.ui.IEditorInput editorInput,
                             org.eclipse.core.runtime.IProgressMonitor monitor)

Convenience constructor for use by IEditorPart.

Parameters:

editorInput - IEditorInput for the IEditorPart.

monitor - IProgressMonitor.

FileConfigurationItem

public FileConfigurationItem(org.eclipse.core.resources.IFile file,
                             org.eclipse.core.runtime.IProgressMonitor monitor)

Initiate with the IFile containing the configuration and the IProgressMonitor.

Parameters:

file - IFile containing configuration.

monitor - IProgressMonitor.

Method Detail

getFile

public static org.eclipse.core.resources.IFile getFile(org.eclipse.ui.IEditorInput editorInput)

Obtains the IFile from the input IEditorInput.

Parameters:

editorInput - IEditorInput.

Returns:

IFile for the input IEditorInput.

getFile

public static org.eclipse.core.resources.IFile getFile(AbstractOfficeFloorEditPart<?,?,?> editPart)

Convenience method to obtain the IFile for the AbstractOfficeFloorEditPart.

Parameters:

editPart - AbstractOfficeFloorEditPart.

Returns:

IFile.

getProject

public static org.eclipse.core.resources.IProject getProject(AbstractOfficeFloorEditPart<?,?,?> editPart)

Convenience method to obtain the IProject for the AbstractOfficeFloorEditPart.

Parameters:

editPart - AbstractOfficeFloorEditPart.

Returns:

IProject.

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.

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.

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.

getFileName

public String getFileName()

Obtains the name of the underlying file.

Returns:

Name of file.

getFile

public org.eclipse.core.resources.IFile getFile()

Returns the underlying file.

Returns:

Underlying file.