com.ecyrd.jspwiki.modules
Class WikiModuleInfo

java.lang.Object
  extended by com.ecyrd.jspwiki.modules.WikiModuleInfo
Direct Known Subclasses:
PluginManager.WikiPluginInfo

public class WikiModuleInfo
extends Object

A WikiModule describes whatever JSPWiki plugin there is: it can be a plugin, an editor, a filter, etc.

Since:
2.4
Author:
jalkanen

Field Summary
protected  String m_author
           
protected  String m_name
           
protected  URL m_resource
           
protected  String m_scriptLocation
           
protected  String m_scriptText
           
protected  String m_stylesheetLocation
           
protected  String m_stylesheetText
           
 
Constructor Summary
WikiModuleInfo()
           
 
Method Summary
 String getAuthor()
          Returns the name of the author of this plugin (if defined).
 String getName()
          Returns the common name for this particular module.
 String getScriptLocation()
           
 String getStylesheetLocation()
           
protected  String getTextResource(String resourceLocation)
           
protected  void initializeFromXML(Element el)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_name

protected String m_name

m_scriptLocation

protected String m_scriptLocation

m_scriptText

protected String m_scriptText

m_stylesheetLocation

protected String m_stylesheetLocation

m_stylesheetText

protected String m_stylesheetText

m_author

protected String m_author

m_resource

protected URL m_resource
Constructor Detail

WikiModuleInfo

public WikiModuleInfo()
Method Detail

initializeFromXML

protected void initializeFromXML(Element el)

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.

getStylesheetLocation

public String getStylesheetLocation()

getScriptLocation

public String getScriptLocation()

getAuthor

public String getAuthor()
Returns the name of the author of this plugin (if defined).

Returns:
Author name, or null.

getTextResource

protected String getTextResource(String resourceLocation)
                          throws IOException
Throws:
IOException