Package org.eclipse.ease.modules

Class ModuleDefinition

java.lang.Object
org.eclipse.ease.modules.ModuleDefinition
public class ModuleDefinition extends Object

  • Constructor Details

  • Method Details

    • forInstance

      public static ModuleDefinition forInstance(Object element)

    • getName

      public String getName()

    • getDependencies

      public List<ModuleDefinition.ModuleDependency> getDependencies()
      Get module dependencies.
      Returns:
      required dependencies

    • getModuleClass

      public 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 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 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 String getId()

    • getBundleID

      public String getBundleID()

    • getMethods

      public List<Method> getMethods()

    • getFields

      public List<Field> getFields()

    • getHelpLocation

      public String getHelpLocation(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

    • getModuleEntries

      public List<ModuleDefinition.ModuleEntry<?>> getModuleEntries()

    • containsEntry

      public boolean containsEntry(String entryName)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object