Apache JMeter
2.1.1

org.apache.jmeter.testelement
Class TestPlan

java.lang.Object
  extended byorg.apache.jmeter.testelement.AbstractTestElement
      extended byorg.apache.jmeter.testelement.TestPlan
All Implemented Interfaces:
Cloneable, Serializable, TestElement, TestListener

public class TestPlan
extends AbstractTestElement
implements Serializable, TestListener

Version:
$Revision: 1.17.2.5 $ Last updated: $Date: 2005/09/23 23:02:50 $
Author:
Michael Stover Created March 13, 2001
See Also:
Serialized Form

Field Summary
static String BASEDIR
           
static String CLASSPATHS
           
static String COMMENTS
           
static String FUNCTIONAL_MODE
           
static String SERIALIZE_THREADGROUPS
           
static String THREAD_GROUPS
           
static String USER_DEFINED_VARIABLES
           
 
Fields inherited from interface org.apache.jmeter.testelement.TestElement
ENABLED, GUI_CLASS, NAME, TEST_CLASS
 
Constructor Summary
TestPlan()
           
TestPlan(String name)
           
 
Method Summary
 void addConfigElement(ConfigElement c)
          Adds a feature to the ConfigElement attribute of the TestPlan object.
 void addJMeterComponent(TestElement child)
           
 void addParameter(String name, String value)
           
 void addTestElement(TestElement tg)
           
 void addThreadGroup(ThreadGroup group)
          Adds a feature to the ThreadGroup attribute of the TestPlan object.
static TestPlan createTestPlan(String name)
           
 String getBasedir()
           
static boolean getFunctionalMode()
          Gets the static copy of the functional mode
 String getTestPlanClasspath()
          Returns a string in CSV format
 String[] getTestPlanClasspathArray()
           
 Collection getThreadGroups()
          Gets the ThreadGroups attribute of the TestPlan object.
 Map getUserDefinedVariables()
           
 boolean isFunctionalMode()
          Fetches the functional mode property
 boolean isSerialized()
          Fetch the serialize threadgroups property
 void prepareForPreCompile()
           
 void setBasedir(String b)
           
 void setFunctionalMode(boolean funcMode)
           
 void setSerialized(boolean serializeTGs)
           
 void setTestPlanClasspath(String text)
          Set the classpath for the test plan
 void setTestPlanClasspathArray(String[] text)
           
 void setUserDefinedVariables(Arguments vars)
           
 void testEnded()
          Called once for all threads after the end of a test
 void testEnded(String host)
           
 void testIterationStart(LoopIterationEvent event)
          Each time through a Thread Group's test script, an iteration event is fired.
 void testStarted()
          Called just before the start of the test Note that not all the test variables will have been set up at this point.
 void testStarted(String host)
           
 
Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addProperty, canRemove, clear, clearTemporary, clone, emptyTemporary, equals, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getThreadContext, getThreadName, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, nextIsNull, propertyIterator, recoverRunningVersion, removeProperty, setName, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, threadFinished, threadStarted, traverse, traverseCollection, traverseMap, traverseProperty
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

THREAD_GROUPS

public static final String THREAD_GROUPS
See Also:
Constant Field Values

FUNCTIONAL_MODE

public static final String FUNCTIONAL_MODE
See Also:
Constant Field Values

USER_DEFINED_VARIABLES

public static final String USER_DEFINED_VARIABLES
See Also:
Constant Field Values

SERIALIZE_THREADGROUPS

public static final String SERIALIZE_THREADGROUPS
See Also:
Constant Field Values

CLASSPATHS

public static final String CLASSPATHS
See Also:
Constant Field Values

COMMENTS

public static final String COMMENTS
See Also:
Constant Field Values

BASEDIR

public static final String BASEDIR
See Also:
Constant Field Values
Constructor Detail

TestPlan

public TestPlan()

TestPlan

public TestPlan(String name)
Method Detail

prepareForPreCompile

public void prepareForPreCompile()

isFunctionalMode

public boolean isFunctionalMode()
Fetches the functional mode property

Returns:
functional mode

setUserDefinedVariables

public void setUserDefinedVariables(Arguments vars)

getBasedir

public String getBasedir()

setBasedir

public void setBasedir(String b)

getUserDefinedVariables

public Map getUserDefinedVariables()

setFunctionalMode

public void setFunctionalMode(boolean funcMode)

getFunctionalMode

public static boolean getFunctionalMode()
Gets the static copy of the functional mode

Returns:
mode

setSerialized

public void setSerialized(boolean serializeTGs)

setTestPlanClasspath

public void setTestPlanClasspath(String text)
Set the classpath for the test plan

Parameters:
text -

setTestPlanClasspathArray

public void setTestPlanClasspathArray(String[] text)

getTestPlanClasspathArray

public String[] getTestPlanClasspathArray()

getTestPlanClasspath

public String getTestPlanClasspath()
Returns a string in CSV format

Returns:

isSerialized

public boolean isSerialized()
Fetch the serialize threadgroups property

Returns:
serialized setting

addParameter

public void addParameter(String name,
                         String value)

createTestPlan

public static TestPlan createTestPlan(String name)

addTestElement

public void addTestElement(TestElement tg)
Specified by:
addTestElement in interface TestElement
Overrides:
addTestElement in class AbstractTestElement

addJMeterComponent

public void addJMeterComponent(TestElement child)

getThreadGroups

public Collection getThreadGroups()
Gets the ThreadGroups attribute of the TestPlan object.

Returns:
the ThreadGroups value

addConfigElement

public void addConfigElement(ConfigElement c)
Adds a feature to the ConfigElement attribute of the TestPlan object.

Parameters:
c - the feature to be added to the ConfigElement attribute

addThreadGroup

public void addThreadGroup(ThreadGroup group)
Adds a feature to the ThreadGroup attribute of the TestPlan object.

Parameters:
group - the feature to be added to the ThreadGroup attribute

testEnded

public void testEnded()
Description copied from interface: TestListener
Called once for all threads after the end of a test

Specified by:
testEnded in interface TestListener
See Also:
StandardJMeterEngine.stopTest()

testEnded

public void testEnded(String host)
Specified by:
testEnded in interface TestListener

testIterationStart

public void testIterationStart(LoopIterationEvent event)
Description copied from interface: TestListener
Each time through a Thread Group's test script, an iteration event is fired.

Specified by:
testIterationStart in interface TestListener
Parameters:
event -

testStarted

public void testStarted()
Description copied from interface: TestListener
Called just before the start of the test Note that not all the test variables will have been set up at this point.

Specified by:
testStarted in interface TestListener
See Also:
StandardJMeterEngine.run()

testStarted

public void testStarted(String host)
Specified by:
testStarted in interface TestListener

Apache JMeter
2.1.1

Copyright © 1998-2005 Apache Software Foundation. All Rights Reserved.