org.xwiki.rendering.macro.script
Class ScriptMacroParameters

java.lang.Object
  extended by org.xwiki.rendering.macro.script.ScriptMacroParameters
Direct Known Subclasses:
JSR223ScriptMacroParameters, VelocityMacroParameters

public class ScriptMacroParameters
extends Object

Parameters for the AbstractScriptMacro Macro.

Since:
1.7M3

Constructor Summary
ScriptMacroParameters()
           
 
Method Summary
 String getJars()
           
 boolean isOutput()
           
 boolean isWiki()
           
 void setJars(String jarURLsAsString)
           
 void setOutput(boolean output)
           
 void setWiki(boolean wiki)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ScriptMacroParameters

public ScriptMacroParameters()
Method Detail

setOutput

public void setOutput(boolean output)
Parameters:
output - indicate the output result has to be inserted back in the document.

isOutput

public boolean isOutput()
Returns:
indicate the output result has to be inserted back in the document.

setWiki

public void setWiki(boolean wiki)
Parameters:
wiki - indicate if the result of the script execution has to be parsed by the current wiki parser. If not it's put in a verbatim block.
Since:
2.0M1

isWiki

public boolean isWiki()
Returns:
indicate if the result of the script execution has to be parsed by the current wiki parser.
Since:
2.0M1

setJars

public void setJars(String jarURLsAsString)
Parameters:
jarURLsAsString - see getJars()

getJars

public String getJars()
Returns:
the list of JARs to be added to the script execution class loader, see DefaultAttachmentClassLoaderFactory for more details