net.officefloor.eclipse.repository.project

Class ProjectConfigurationContext

java.lang.Object

net.officefloor.eclipse.repository.project.ProjectConfigurationContext

All Implemented Interfaces:

ConfigurationContext

public class ProjectConfigurationContext
extends Object
implements ConfigurationContext

Implementation of ConfigurationContext for a IProject providing context for a IFile.

Author:

Daniel Sagenschneider

Constructor Summary

Constructors

Constructor and Description
ProjectConfigurationContext(org.eclipse.ui.IEditorInput editorInput) Convenience constructor.
ProjectConfigurationContext(org.eclipse.core.resources.IProject project) Initiate with the IProject providing context.
ProjectConfigurationContext(org.eclipse.core.resources.IProject project, org.eclipse.core.runtime.IProgressMonitor monitor) Initiate with the IProject providing context.

Method Summary

Modifier and Type	Method and Description
ConfigurationItem	createConfigurationItem(String location, InputStream configuration) Creates a new ConfigurationItem at the relative location.
void	deleteConfigurationItem(String path) Deletes the ConfigurationItem at the relative location.
ConfigurationItem	getConfigurationItem(String location) Obtains the ConfigurationItem at the relative location.
String	getLocation() Obtains the location for this ConfigurationContext.
org.eclipse.core.resources.IProject	getProject() Obtain the IProject.
static org.eclipse.core.resources.IProject	getProject(org.eclipse.ui.IEditorInput editorInput) Obtains the IProject from the input IEditorInput.
boolean	isReadOnly() Indicates if the configuration is read-only.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectConfigurationContext

public ProjectConfigurationContext(org.eclipse.core.resources.IProject project)

Initiate with the IProject providing context.

Parameters:

project - IProject providing context.

ProjectConfigurationContext

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

Convenience constructor.

Parameters:

editorInput - IEditorInput.

ProjectConfigurationContext

public ProjectConfigurationContext(org.eclipse.core.resources.IProject project,
                                   org.eclipse.core.runtime.IProgressMonitor monitor)

Initiate with the IProject providing context.

Parameters:

project - IProject providing context.

monitor - IProgressMonitor. If only retrieving may specify null.

Method Detail

getProject

public static org.eclipse.core.resources.IProject getProject(org.eclipse.ui.IEditorInput editorInput)

Obtains the IProject from the input IEditorInput.

Parameters:

editorInput - IEditorInput.

Returns:

IProject for the input IEditorInput.

getProject

public org.eclipse.core.resources.IProject getProject()

Obtain the IProject.

Returns:

IProject.

getLocation

public String getLocation()

Description copied from interface: ConfigurationContext

Obtains the location for this ConfigurationContext.

This value is used in the equality of ConfigurationContext instances.

Specified by:

getLocation in interface ConfigurationContext

Returns:

Location for this ConfigurationContext.

getConfigurationItem

public ConfigurationItem getConfigurationItem(String location)
                                       throws Exception

Description copied from interface: ConfigurationContext

Obtains the ConfigurationItem at the relative location.

Specified by:

getConfigurationItem in interface ConfigurationContext

Parameters:

location - Relative location of the ConfigurationItem to obtain.

Returns:

ConfigurationItem.

Throws:

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

isReadOnly

public boolean isReadOnly()

Description copied from interface: ConfigurationContext

Indicates if the configuration is read-only.

Specified by:

isReadOnly in interface ConfigurationContext

Returns:

true should the configuration be read-only.

createConfigurationItem

public ConfigurationItem createConfigurationItem(String location,
                                                 InputStream configuration)
                                          throws Exception

Description copied from interface: ConfigurationContext

Creates a new ConfigurationItem at the relative location.

Specified by:

createConfigurationItem in interface ConfigurationContext

Parameters:

location - 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

public void deleteConfigurationItem(String path)
                             throws Exception,
                                    ReadOnlyConfigurationException

Description copied from interface: ConfigurationContext

Deletes the ConfigurationItem at the relative location.

Specified by:

deleteConfigurationItem in interface ConfigurationContext

Parameters:

path - 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.