JTR 5.0 API Documentation

jtr.config.script
Class PScript

java.lang.Object
  extended by jtr.config.script.PScript
All Implemented Interfaces:
java.io.Serializable, Script

public class PScript
extends java.lang.Object
implements java.io.Serializable, Script

Class that maps the p-script element of the jtr.xml configuration file. See the jtr.xsd grammar for more information. A PScrip is a parameterization-script, that is a script used to produce values that must be used to initialize a runner's property.
Every PScrip has a name that must be unique in the JTR-configuration it belongs to.
Obviously, it also has a body, an output container and a set of formal parameters.

Since:
5.0
Version:
5.0
Author:
frusso
See Also:
Serialized Form

Constructor Summary
PScript()
           
 
Method Summary
 java.lang.String getBody()
          Get the script's body.
 Inputs getInputs()
          Get the formal parameters required by the script.
 java.lang.String getName()
          Get the script's unique name.
 java.lang.String getOutput()
          Get the name of the variable that must store the script's return value if any.
 void setBody(java.lang.String val)
          Set the script's body.
 void setInputs(Inputs val)
          Set the formal parameters required by the script.
 void setName(java.lang.String val)
          Set the script's unique name.
 void setOutput(java.lang.String val)
          Set the name of the variable that will store the script's output if any.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PScript

public PScript()
Method Detail

setName

public void setName(java.lang.String val)
Set the script's unique name.

Parameters:
val -

setBody

public void setBody(java.lang.String val)
Set the script's body.

Parameters:
val -

setOutput

public void setOutput(java.lang.String val)
Set the name of the variable that will store the script's output if any.

Parameters:
val -

setInputs

public void setInputs(Inputs val)
Set the formal parameters required by the script.

Parameters:
val -

getName

public java.lang.String getName()
Get the script's unique name.

Returns:

getBody

public java.lang.String getBody()
Get the script's body.

Specified by:
getBody in interface Script
Returns:

getOutput

public java.lang.String getOutput()
Get the name of the variable that must store the script's return value if any.

Returns:

getInputs

public Inputs getInputs()
Get the formal parameters required by the script.

Returns:

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

The JTR Project is licensed under GPL version 2