|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectmadkit.pluginmanager.actions.AddDocumentationReference
public class AddDocumentationReference
Adds a link in the documentation index of Madkit.
The documentation index is divided by sections. Sections can be
added at will, however we encourage you
to use on of the following sections:
Field Summary | |
---|---|
protected java.io.File |
_madkitDir
|
Constructor Summary | |
---|---|
AddDocumentationReference(java.io.File madkitDirectory,
java.lang.String plugin,
Version pluginVersion)
|
Method Summary | |
---|---|
protected void |
debug(java.lang.String str)
|
boolean |
execute()
Request the action to execute. |
static void |
generateHtmlDocumentation(java.io.File madkitDirectory)
Creates the Madkit Html Documentation index. |
java.lang.String |
getFailureReason()
Gets the failure reason. |
java.util.Collection |
getMandatoryParameters()
Get the Madatory parameters needed by the action to execute |
java.lang.String |
getName()
Gets the action name. |
java.util.Collection |
getOptionalParameters()
Get the Optional/b> parameters needed by the action to execute |
java.lang.String |
getOwnerPlugin()
Gets the name of the plugin owner of this action |
Version |
getOwnerPluginVersion()
Gets the version of the plugin owner of this action |
java.lang.String |
getQuestionToUser()
If showAskUser() returns true, this method is called to get the Question. |
protected Document |
openXMLDocument(java.io.File file)
|
static void |
removePlugin(java.io.File madkitDirectory,
java.lang.String plugin,
Version pluginVersion)
|
java.util.Collection |
requiredPlugins()
Gets the required plugins to execute this action. |
void |
setParamenters(java.util.Properties params)
Sets the parameters obtained from the plugin xml file. |
boolean |
shouldAskUser()
Should the Plugin Manager ask for user confirmation before executing the action. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface madkit.pluginmanager.Action |
---|
getName, getOwnerPlugin, getOwnerPluginVersion |
Field Detail |
---|
protected java.io.File _madkitDir
Constructor Detail |
---|
public AddDocumentationReference(java.io.File madkitDirectory, java.lang.String plugin, Version pluginVersion)
Method Detail |
---|
public java.util.Collection requiredPlugins()
Action
requiredPlugins
in interface Action
public java.util.Collection getMandatoryParameters()
Action
getMandatoryParameters
in interface Action
Action.getOptionalParameters()
public java.util.Collection getOptionalParameters()
Action
getOptionalParameters
in interface Action
Action.getMadatoryParameters()
public void setParamenters(java.util.Properties params)
Action
params
will contain both, mandatory and optional parameters
setParamenters
in interface Action
params
- set of parameterspublic boolean execute()
Action
execute
in interface Action
public java.lang.String getFailureReason()
Action
false
getFailureReason
in interface Action
public static final void generateHtmlDocumentation(java.io.File madkitDirectory) throws java.io.IOException
madkitDirectory
-
java.io.IOException
public static final void removePlugin(java.io.File madkitDirectory, java.lang.String plugin, Version pluginVersion) throws java.io.IOException
java.io.IOException
public boolean shouldAskUser()
Action
shouldAskUser
in interface Action
public java.lang.String getQuestionToUser()
Action
getQuestionToUser
in interface Action
public java.lang.String getOwnerPlugin()
Action
getOwnerPlugin
in interface Action
public Version getOwnerPluginVersion()
Action
getOwnerPluginVersion
in interface Action
public java.lang.String getName()
Action
getName
in interface Action
protected Document openXMLDocument(java.io.File file) throws SAXException, java.io.IOException, javax.xml.parsers.ParserConfigurationException, javax.xml.parsers.FactoryConfigurationError
SAXException
java.io.IOException
javax.xml.parsers.ParserConfigurationException
javax.xml.parsers.FactoryConfigurationError
protected void debug(java.lang.String str)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |