Apache JMeter
2.0.1.20050615

org.apache.jmeter.functions
Class RegexFunction

java.lang.Object
  extended byorg.apache.jmeter.functions.AbstractFunction
      extended byorg.apache.jmeter.functions.RegexFunction
All Implemented Interfaces:
Function, Serializable

public class RegexFunction
extends AbstractFunction
implements Serializable

See Also:
Serialized Form

Nested Class Summary
static class RegexFunction.Test
           
 
Field Summary
static String ALL
           
static String KEY
           
static String RAND
           
 
Constructor Summary
RegexFunction()
           
 
Method Summary
 String execute(SampleResult previousResult, Sampler currentSampler)
          Given the previous SampleResult and the current Sampler, return a string to use as a replacement value for the function call.
 List getArgumentDesc()
          Return a list of strings briefly describing each parameter your function takes.
 String getReferenceKey()
          Return the name of your function.
 void setParameters(Collection parameters)
          A collection of the parameters used to configure your function.
 
Methods inherited from class org.apache.jmeter.functions.AbstractFunction
execute, getVariables
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALL

public static final String ALL
See Also:
Constant Field Values

RAND

public static final String RAND
See Also:
Constant Field Values

KEY

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

RegexFunction

public RegexFunction()
Method Detail

execute

public String execute(SampleResult previousResult,
                      Sampler currentSampler)
               throws InvalidVariableException
Description copied from interface: Function
Given the previous SampleResult and the current Sampler, return a string to use as a replacement value for the function call. Assume "setParameter" was previously called. This method must be threadsafe - multiple threads will be using the same object.

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

getArgumentDesc

public List getArgumentDesc()
Description copied from interface: Function
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. Add your strings to all org.apache.jmeter.resources.*.properties files. Do not worry about translating - that's someone else's responsibility. 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.

Specified by:
getArgumentDesc in interface Function

getReferenceKey

public String getReferenceKey()
Description copied from interface: Function
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()

setParameters

public void setParameters(Collection parameters)
                   throws InvalidVariableException
Description copied from interface: Function
A collection of the parameters used to configure your function. Each parameter is a CompoundFunction and can be resolved by calling the execute() method of the CompoundFunction (which should be done at execution.)

Specified by:
setParameters in interface Function
Specified by:
setParameters in class AbstractFunction
Throws:
InvalidVariableException
See Also:
Function.setParameters(Collection)

Apache JMeter
2.0.1.20050615

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