org.eclipse.ease.modules

Class ModuleDefinition

java.lang.Object

org.eclipse.ease.modules.ModuleDefinition

public class ModuleDefinition
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ModuleDefinition.ModuleDependency

Constructor Summary

Constructors

Constructor and Description
ModuleDefinition(org.eclipse.core.runtime.IConfigurationElement config)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	createModuleInstance() Create a new instance of the module.
boolean	equals(java.lang.Object obj)
java.lang.String	getBundleID()
static ModuleDefinition	getDefinition(java.lang.Object module) Retrieve the module definition for a given module instance.
java.util.List<ModuleDefinition.ModuleDependency>	getDependencies() Get module dependencies.
java.util.List<java.lang.reflect.Field>	getFields()
java.lang.String	getHelpLocation(java.lang.String topic) Provide the help location for a given topic.
java.lang.String	getId()
org.eclipse.jface.resource.ImageDescriptor	getImageDescriptor()
java.util.List<java.lang.reflect.Method>	getMethods()
java.lang.Class<?>	getModuleClass() Get the class definition of the provided module.
java.lang.String	getName()
org.eclipse.core.runtime.IPath	getPath() Get the full module name.
int	hashCode()
boolean	isDeprecated() Check deprecation status of module.
boolean	isVisible() Get visibility status of module.
void	resetVisible() Reset visibility to defaults.
void	setVisible(boolean visible) Sets visibility status of module in preferences

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModuleDefinition

public ModuleDefinition(org.eclipse.core.runtime.IConfigurationElement config)

Method Detail

getDefinition

public static ModuleDefinition getDefinition(java.lang.Object module)

Retrieve the module definition for a given module instance.

Parameters:

module - module instance to look up

Returns:

module definition or null

getName

public java.lang.String getName()

getDependencies

public java.util.List<ModuleDefinition.ModuleDependency> getDependencies()

Get module dependencies.

Returns:

required dependencies

getModuleClass

public java.lang.Class<?> getModuleClass()

Get the class definition of the provided module. Will not (by default) create an instance of this class, but look up the class definition directly.

Returns:

class definition of module contribution

createModuleInstance

public java.lang.Object createModuleInstance()

Create a new instance of the module.

Returns:

module instance

isVisible

public boolean isVisible()

Get visibility status of module. Modules have a default visibility stored in its definition. Users may override this setting using preferences. Invisible modules may still be used in scripts. However they are not visible in the UI.

Returns:

true when visible

setVisible

public void setVisible(boolean visible)

Sets visibility status of module in preferences

Parameters:

visible - true to make visible

resetVisible

public void resetVisible()

Reset visibility to defaults.

getPath

public org.eclipse.core.runtime.IPath getPath()

Get the full module name. The full name consists of optional parent categories and the module name itself.

Returns:

absolute path of this module definition

getId

public java.lang.String getId()

getImageDescriptor

public org.eclipse.jface.resource.ImageDescriptor getImageDescriptor()

getBundleID

public java.lang.String getBundleID()

getMethods

public java.util.List<java.lang.reflect.Method> getMethods()

getFields

public java.util.List<java.lang.reflect.Field> getFields()

getHelpLocation

public java.lang.String getHelpLocation(java.lang.String topic)

Provide the help location for a given topic. Returns the help URI needed to open the according help page.

Parameters:

topic - help topic within module

Returns:

link to help

isDeprecated

public boolean isDeprecated()

Check deprecation status of module.

Returns:

true when module is deprecated

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object