Package net.officefloor.gef.bridge

Interface EnvironmentBridge

All Known Implementing Classes:

ClassLoaderEnvironmentBridge, EclipseEnvironmentBridge

public interface EnvironmentBridge

Bridges the editor to the environment.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EnvironmentBridge.PreferenceEvent	Preference event.
static interface	EnvironmentBridge.PreferenceListener	Preference listener.
static interface	EnvironmentBridge.SelectionHandler	Handles selection result.

Method Summary

Modifier and Type	Method	Description
void	addPreferenceListener(EnvironmentBridge.PreferenceListener listener)	Adds a EnvironmentBridge.PreferenceListener.
java.lang.ClassLoader	getClassLoader()	Obtains the ClassLoader.
OfficeFloorCompiler	getOfficeFloorCompiler()	Obtains the OfficeFloorCompiler.
java.lang.String	getPreference(java.lang.String preferenceId)	Obtains the preference.
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 superType)	Indicates if super type.
<S> java.lang.Class<? extends S>	loadClass(java.lang.String className, java.lang.Class<S> 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 superType, 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.

Method Detail

isClassOnClassPath

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

Indicates if Class on the Class path.

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

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

Indicates if super type.

Parameters:

className - Name of Class.

superType - Super type Class.

Returns:

true if super type Class.

Throws:

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

loadClass

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

Loads the Class.

Type Parameters:

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

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

Obtains the ClassLoader.

Returns:

ClassLoader.

Throws:

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

getOfficeFloorCompiler

OfficeFloorCompiler getOfficeFloorCompiler()
                                    throws java.lang.Exception

Obtains the OfficeFloorCompiler.

Returns:

OfficeFloorCompiler.

Throws:

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

selectClass

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

Selects a Class.

Parameters:

searchText - Search text to find the Class.

superType - Super type of the Class.

handler - EnvironmentBridge.SelectionHandler.

isResourceOnClassPath

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

Indicates if the resource is on the Class path.

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

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

Selects a resource from the Class path.

Parameters:

searchText - Search text to find the Class path resource.

handler - EnvironmentBridge.SelectionHandler.

getPreference

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

Obtains the preference.

Parameters:

preferenceId - Preference identifier.

Returns:

Preference value or null if no configured.

setPreference

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

Specifies the preference value.

Parameters:

preferenceId - Preference identifier.

value - Value for the preference.

resetPreference

void resetPreference(java.lang.String preferenceId)

Resets the preference to default value.

Parameters:

preferenceId - Preference identifier.

addPreferenceListener

void addPreferenceListener(EnvironmentBridge.PreferenceListener listener)

Adds a EnvironmentBridge.PreferenceListener.

Parameters:

listener - EnvironmentBridge.PreferenceListener.