Package org.apache.wiki.modules

Class WikiModuleInfo

java.lang.Object
org.apache.wiki.modules.WikiModuleInfo
All Implemented Interfaces:
Comparable<WikiModuleInfo>
Direct Known Subclasses:
DefaultPluginManager.WikiPluginInfo
public class WikiModuleInfo extends Object implements Comparable<WikiModuleInfo>
A WikiModule describes whatever JSPWiki plugin there is: it can be a plugin, an editor, a filter, etc.
Since:
2.4

  • Field Details

  • Constructor Details

    • WikiModuleInfo

      public WikiModuleInfo(String name)
      Create a new info container.
      Parameters:
      name - The name of the module.

  • Method Details

    • equals

      public boolean equals(Object obj)
      The WikiModuleInfo is equal to another WikiModuleInfo, if the name is equal. All objects are unique across JSPWiki.
      Overrides:
      equals in class Object
      Parameters:
      obj -
      Returns:

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • initializeFromXML

      protected void initializeFromXML(org.jdom2.Element el)
      Initializes the ModuleInfo from some standard XML elements which are under the given element.
      Parameters:
      el - The element to parse.

    • getAdminBeanClass

      public String getAdminBeanClass()
      Returns the AdminBean class which is supposed to manage this module.
      Returns:
      A class name.

    • getName

      public String getName()
      Returns the common name for this particular module. Note that this is not the class name, nor is it an alias. For different modules the name may have different meanings.

      Every module defines a name, so this method should never return null.

      Returns:
      A module name.

    • getDescription

      public String getDescription()
      The description of what this module does.
      Returns:
      A module description.

    • getModuleUrl

      public String getModuleUrl()
      The URL for this getting more information about this module.
      Returns:
      A module URL.

    • getModuleVersion

      public String getModuleVersion()
      The current version of the implemented module
      Returns:
      A module version.

    • getHtmlTemplate

      public String getHtmlTemplate()
      Return the location of the html template for this module.
      Returns:
      The path to the location.

    • getStylesheetLocation

      public String getStylesheetLocation()
      Returns the style sheet location for this module.
      Returns:
      The path to the location.

    • getScriptLocation

      public String getScriptLocation()
      Return the location of the script for this module.
      Returns:
      The path to the location.

    • getAuthor

      public String getAuthor()
      Returns the name of the author of this plugin (if defined).
      Returns:
      Author name, or null.

    • getAuthorUrl

      public String getAuthorUrl()
      Returns the url of the author of this plugin (if defined).

    • getMinVersion

      public String getMinVersion()
      Returns the minimum version of JSPWiki that this module supports.
      Returns:
      The minimum version.

    • getMaxVersion

      public String getMaxVersion()
      Returns the maximum version of JSPWiki that this module supports.
      Returns:
      The maximum version.

    • getTextResource

      protected String getTextResource(String resourceLocation) throws IOException
      Attempts to locate a resource from a JAR file and returns it as a string.
      Parameters:
      resourceLocation - an URI of the resource
      Returns:
      The content of the file
      Throws:
      IOException - if the JAR file or the resource cannot be read

    • compareTo

      public int compareTo(WikiModuleInfo mod)
      Specified by:
      compareTo in interface Comparable<WikiModuleInfo>