Class ModuleInfo

java.lang.Object
org.tentackle.common.ModuleInfo
public final class ModuleInfo extends Object
Holds information about a module.
Author:
harald

  • Constructor Details

    • ModuleInfo

      public ModuleInfo(ModuleHook hook)
      Creates a module info.
      Parameters:
      hook - the module hook
      Throws:
      TentackleRuntimeException - if the hook does not belong to a named module

  • Method Details

    • getHook

      public ModuleHook getHook()
      Gets the module hook.
      Returns:
      the hook

    • getUrlPath

      public String getUrlPath()
      Gets the URL path of the hook's module.
      Returns:
      the URL path

    • getModule

      public Module getModule()
      Gets the module.
      Returns:
      the module

    • getRequiredModuleNames

      public Set<String> getRequiredModuleNames()
      Gets the names of the required modules.
      Modules required static are not included. Once the module has been sorted by the ModuleSorter, the set contains only the names of required application modules, i.e., modules providing a ModuleHook.
      Returns:
      the directly required names

    • getOrdinal

      public int getOrdinal()
      Gets the module ordinal.
      Higher values come first in module order.
      Returns:
      the ordinal

    • setOrdinal

      public void setOrdinal(int ordinal)
      Sets the ordinal.
      Higher values come first in module order.
      Parameters:
      ordinal - the ordinal

    • toString

      public String toString()
      Overrides:
      toString in class Object