Package org.eclipse.ease.modules
Class ModuleDefinition
java.lang.Object
org.eclipse.ease.modules.ModuleDefinition
public class ModuleDefinition extends Object
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classModuleDefinition.ModuleDependency -
Constructor Summary
Constructors Constructor Description ModuleDefinition(org.eclipse.core.runtime.IConfigurationElement config) -
Method Summary
Modifier and Type Method Description ObjectcreateModuleInstance()Create a new instance of the module.booleanequals(Object obj)static ModuleDefinitionforInstance(Object element)StringgetBundleID()List<ModuleDefinition.ModuleDependency>getDependencies()Get module dependencies.List<Field>getFields()StringgetHelpLocation(String topic)Provide the help location for a given topic.StringgetId()org.eclipse.jface.resource.ImageDescriptorgetImageDescriptor()List<Method>getMethods()Class<?>getModuleClass()Get the class definition of the provided module.StringgetName()org.eclipse.core.runtime.IPathgetPath()Get the full module name.inthashCode()booleanisDeprecated()Check deprecation status of module.booleanisVisible()Get visibility status of module.voidresetVisible()Reset visibility to defaults.voidsetVisible(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:
truewhen visible
-
setVisible
public void setVisible(boolean visible)Sets visibility status of module in preferences.- Parameters:
visible-trueto 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
-
getImageDescriptor
public org.eclipse.jface.resource.ImageDescriptor getImageDescriptor() -
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:
truewhen module is deprecated
-
hashCode
public int hashCode() -
equals
-