Package org.eclipse.ease.modules
Class ModuleDefinition
java.lang.Object
org.eclipse.ease.modules.ModuleDefinition
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static class
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
containsEntry
(String entryName) Create a new instance of the module.boolean
static ModuleDefinition
forInstance
(Object element) Get module dependencies.getHelpLocation
(String topic) Provide the help location for a given topic.getId()
Class<?>
Get the class definition of the provided module.getName()
org.eclipse.core.runtime.IPath
getPath()
Get the full module name.int
hashCode()
boolean
Check deprecation status of module.boolean
Get visibility status of module.void
Reset visibility to defaults.void
setVisible
(boolean visible) Sets visibility status of module in preferences.
-
Constructor Details
-
ModuleDefinition
public ModuleDefinition(org.eclipse.core.runtime.IConfigurationElement config)
-
-
Method Details
-
forInstance
-
getName
-
getDependencies
Get module dependencies.- Returns:
- required dependencies
-
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
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
-
getBundleID
-
getMethods
-
getFields
-
getHelpLocation
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
-
getModuleEntries
-
containsEntry
-
hashCode
public int hashCode() -
equals
-