Apache JMeter

org.apache.jmeter.functions
Class SplitFunction

java.lang.Object
  extended by org.apache.jmeter.functions.AbstractFunction
      extended by org.apache.jmeter.functions.SplitFunction
All Implemented Interfaces:
Function

public class SplitFunction
extends AbstractFunction

Function to split a string into variables

Parameters:

Returns: the input string

Also sets the variables:

Since:
2.0.2

Constructor Summary
SplitFunction()
           
 
Method Summary
 String execute(SampleResult previousResult, Sampler currentSampler)
           N.B. execute() should be synchronized if function is operating with non-thread-safe objects (e.g. operates with files).
 List<String> getArgumentDesc()
          Return a list of strings briefly describing each parameter your function takes.
 String getReferenceKey()
          Return the name of your function.
 void setParameters(Collection<CompoundVariable> parameters)
          A collection of the parameters used to configure your function.
 
Methods inherited from class org.apache.jmeter.functions.AbstractFunction
checkMinParameterCount, checkParameterCount, checkParameterCount, execute, getVariables
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SplitFunction

public SplitFunction()
Method Detail

execute

public String execute(SampleResult previousResult,
                      Sampler currentSampler)
               throws InvalidVariableException

N.B. execute() should be synchronized if function is operating with non-thread-safe objects (e.g. operates with files).

JMeter ensures setParameters() happens-before execute(): setParameters is executed in main thread, and worker threads are started after that.

Specified by:
execute in interface Function
Specified by:
execute in class AbstractFunction
Throws:
InvalidVariableException
See Also:
Function.execute(SampleResult, Sampler)

setParameters

public void setParameters(Collection<CompoundVariable> parameters)
                   throws InvalidVariableException
A collection of the parameters used to configure your function. Each parameter is a CompoundVariable and can be resolved by calling the execute() method of the CompoundVariable (which should be done at execution.)

Specified by:
setParameters in interface Function
Specified by:
setParameters in class AbstractFunction
Throws:
InvalidVariableException
See Also:

Note: This is always called even if no parameters are provided (versions of JMeter after 2.3.1)

getReferenceKey

public String getReferenceKey()
Return the name of your function. Convention is to prepend "__" to the name (ie "__regexFunction")

Specified by:
getReferenceKey in interface Function
Specified by:
getReferenceKey in class AbstractFunction
See Also:
Function.getReferenceKey()

getArgumentDesc

public List<String> getArgumentDesc()
Return a list of strings briefly describing each parameter your function takes. Please use JMeterUtils.getResString(resource_name) to grab a resource string. Otherwise, your help text will be difficult to internationalize. This list is not optional. If you don't wish to write help, you must at least return a List containing the correct number of blank strings, one for each argument.


Apache JMeter

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