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

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

InputStream	getConfiguration()
ConfigurationContext	getContext()
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()
static org.eclipse.core.resources.IProject	getProject(AbstractOfficeFloorEditPart<?,?,?> editPart) Convenience method to obtain the IProject for the AbstractOfficeFloorEditPart.
void	setConfiguration(InputStream configuration)

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()

Specified by:

getLocation in interface ConfigurationItem

getConfiguration

public InputStream getConfiguration()
                             throws Exception

Specified by:

getConfiguration in interface ConfigurationItem

Throws:

Exception

setConfiguration

public void setConfiguration(InputStream configuration)
                      throws Exception

Specified by:

setConfiguration in interface ConfigurationItem

Throws:

Exception

getContext

public ConfigurationContext getContext()

Specified by:

getContext in interface 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.