Package net.officefloor.eclipse.bridge

Class EclipseEnvironmentBridge

java.lang.Object

net.officefloor.eclipse.bridge.EclipseEnvironmentBridge

All Implemented Interfaces:

EnvironmentBridge

public class EclipseEnvironmentBridge
extends java.lang.Object
implements EnvironmentBridge

Eclipse EnvironmentBridge.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from interface net.officefloor.gef.bridge.EnvironmentBridge

EnvironmentBridge.PreferenceEvent, EnvironmentBridge.PreferenceListener, EnvironmentBridge.SelectionHandler

Constructor Summary

Constructors

Constructor	Description
EclipseEnvironmentBridge()	Initialise for non IJavaProject specific bridging.
EclipseEnvironmentBridge(org.eclipse.jdt.core.IJavaProject javaProject)	Instantiate for IJavaProject specific bridging.

Method Summary

Modifier and Type	Method	Description
void	addPreferenceListener(EnvironmentBridge.PreferenceListener listener)	Adds a EnvironmentBridge.PreferenceListener.
void	dispose()	Disposes of resources.
java.lang.ClassLoader	getClassLoader()	Obtains the ClassLoader.
OfficeFloorCompiler	getOfficeFloorCompiler()	Obtains the OfficeFloorCompiler.
java.lang.String	getPreference(java.lang.String preferenceId)	Obtains the preference.
void	init(org.eclipse.swt.widgets.Shell parentShell)	Initialise.
boolean	isClassOnClassPath(java.lang.String className)	Indicates if Class on the Class path.
boolean	isResourceOnClassPath(java.lang.String resourcePath)	Indicates if the resource is on the Class path.
boolean	isSuperType(java.lang.String className, java.lang.String superTypeName)	Indicates if super type.
<T> java.lang.Class<? extends T>	loadClass(java.lang.String className, java.lang.Class<T> superType)	Loads the Class.
void	resetPreference(java.lang.String preferenceId)	Resets the preference to default value.
void	selectClass(java.lang.String searchText, java.lang.String superTypeName, EnvironmentBridge.SelectionHandler handler)	Selects a Class.
void	selectClassPathResource(java.lang.String searchText, EnvironmentBridge.SelectionHandler handler)	Selects a resource from the Class path.
void	setPreference(java.lang.String preferenceId, java.lang.String value)	Specifies the preference value.

Methods inherited from class java.lang.Object

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

Constructor Detail

EclipseEnvironmentBridge

public EclipseEnvironmentBridge(org.eclipse.jdt.core.IJavaProject javaProject)

Instantiate for IJavaProject specific bridging.

Parameters:

javaProject - IJavaProject.

EclipseEnvironmentBridge

public EclipseEnvironmentBridge()

Initialise for non IJavaProject specific bridging.

Method Detail

init

public void init(org.eclipse.swt.widgets.Shell parentShell)

Initialise.

Parameters:

parentShell - Parent Shell.

dispose

public void dispose()
             throws java.io.IOException

Disposes of resources.

Throws:

java.io.IOException - If fails to dispose.

isClassOnClassPath

public boolean isClassOnClassPath(java.lang.String className)
                           throws java.lang.Exception

Description copied from interface: EnvironmentBridge

Indicates if Class on the Class path.

Specified by:

isClassOnClassPath in interface EnvironmentBridge

Parameters:

className - Name of the Class.

Returns:

true if Class on the Class path.

Throws:

java.lang.Exception - If fails to determine if on Class path.

isSuperType

public boolean isSuperType(java.lang.String className,
                           java.lang.String superTypeName)
                    throws java.lang.Exception

Description copied from interface: EnvironmentBridge

Indicates if super type.

Specified by:

isSuperType in interface EnvironmentBridge

Parameters:

className - Name of Class.

superTypeName - Super type Class.

Returns:

true if super type Class.

Throws:

java.lang.Exception - If fails to determine if super type.

selectClass

public void selectClass(java.lang.String searchText,
                        java.lang.String superTypeName,
                        EnvironmentBridge.SelectionHandler handler)

Description copied from interface: EnvironmentBridge

Selects a Class.

Specified by:

selectClass in interface EnvironmentBridge

Parameters:

searchText - Search text to find the Class.

superTypeName - Super type of the Class.

handler - EnvironmentBridge.SelectionHandler.

loadClass

public <T> java.lang.Class<? extends T> loadClass(java.lang.String className,
                                                  java.lang.Class<T> superType)
                                           throws java.lang.Exception

Description copied from interface: EnvironmentBridge

Loads the Class.

Specified by:

loadClass in interface EnvironmentBridge

Type Parameters:

T - Super type.

Parameters:

className - Name of Class.

superType - Super type required of Class.

Returns:

Class.

Throws:

java.lang.Exception - If fails to load the Class.

getClassLoader

public java.lang.ClassLoader getClassLoader()
                                     throws java.lang.Exception

Description copied from interface: EnvironmentBridge

Obtains the ClassLoader.

Specified by:

getClassLoader in interface EnvironmentBridge

Returns:

ClassLoader.

Throws:

java.lang.Exception - If fails to obtain ClassLoader.

getOfficeFloorCompiler

public OfficeFloorCompiler getOfficeFloorCompiler()
                                           throws java.lang.Exception

Description copied from interface: EnvironmentBridge

Obtains the OfficeFloorCompiler.

Specified by:

getOfficeFloorCompiler in interface EnvironmentBridge

Returns:

OfficeFloorCompiler.

Throws:

java.lang.Exception - If fails to obtain OfficeFloorCompiler.

isResourceOnClassPath

public boolean isResourceOnClassPath(java.lang.String resourcePath)
                              throws java.lang.Exception

Description copied from interface: EnvironmentBridge

Indicates if the resource is on the Class path.

Specified by:

isResourceOnClassPath in interface EnvironmentBridge

Parameters:

resourcePath - Resource path.

Returns:

true if the resource is on the Class path.

Throws:

java.lang.Exception - If fails to determine if on Class path.

selectClassPathResource

public void selectClassPathResource(java.lang.String searchText,
                                    EnvironmentBridge.SelectionHandler handler)

Description copied from interface: EnvironmentBridge

Selects a resource from the Class path.

Specified by:

selectClassPathResource in interface EnvironmentBridge

Parameters:

searchText - Search text to find the Class path resource.

handler - EnvironmentBridge.SelectionHandler.

getPreference

public java.lang.String getPreference(java.lang.String preferenceId)

Description copied from interface: EnvironmentBridge

Obtains the preference.

Specified by:

getPreference in interface EnvironmentBridge

Parameters:

preferenceId - Preference identifier.

Returns:

Preference value or null if no configured.

setPreference

public void setPreference(java.lang.String preferenceId,
                          java.lang.String value)

Description copied from interface: EnvironmentBridge

Specifies the preference value.

Specified by:

setPreference in interface EnvironmentBridge

Parameters:

preferenceId - Preference identifier.

value - Value for the preference.

resetPreference

public void resetPreference(java.lang.String preferenceId)

Description copied from interface: EnvironmentBridge

Resets the preference to default value.

Specified by:

resetPreference in interface EnvironmentBridge

Parameters:

preferenceId - Preference identifier.

addPreferenceListener

public void addPreferenceListener(EnvironmentBridge.PreferenceListener listener)

Description copied from interface: EnvironmentBridge

Adds a EnvironmentBridge.PreferenceListener.

Specified by:

addPreferenceListener in interface EnvironmentBridge

Parameters:

listener - EnvironmentBridge.PreferenceListener.