org.apache.jmeter.functions

Class AbstractFunction

Implemented Interfaces:
Function
Known Direct Subclasses:
BeanShell, CharFunction, CSVRead, EscapeHtml, EvalFunction, EvalVarFunction, IntSum, IterationCounter, JavaScript, JexlFunction, LogFunction, LogFunction2, LongSum, MachineName, Property, Property2, Random, RegexFunction, SetProperty, SplitFunction, StringFromFile, ThreadNumber, TimeFunction, UnEscape, UnEscapeHtml, Variable, XPath

public abstract class AbstractFunction
extends Object
implements Function

Provides common methods for all functions

Method Summary

protected void
checkMinParameterCount(Collection parameters, int minimum)
Utility method to check parameter counts.
protected void
checkParameterCount(Collection parameters, int count)
Utility method to check parameter counts.
protected void
checkParameterCount(Collection parameters, int min, int max)
Utility method to check parameter counts.
String
execute()
abstract String
execute(SampleResult previousResult, Sampler currentSampler)
N.B. setParameters() and execute() are called from different threads, so both must be synchronized unless there are no parameters to save
abstract String
getReferenceKey()
protected JMeterVariables
getVariables()
abstract void
setParameters(Collection parameters)
N.B. setParameters() and execute() are called from different threads, so both must be synchronized unless there are no parameters to save

Method Details

checkMinParameterCount

protected void checkMinParameterCount(Collection parameters,
                                      int minimum)
            throws InvalidVariableException
Utility method to check parameter counts.
Parameters:
parameters - collection of parameters
minimum - number of parameters expected
Throws:
InvalidVariableException - if the number of parameters is incorrect

checkParameterCount

protected void checkParameterCount(Collection parameters,
                                   int count)
            throws InvalidVariableException
Utility method to check parameter counts.
Parameters:
parameters - collection of parameters
count - number of parameters expected
Throws:
InvalidVariableException - if the number of parameters is incorrect

checkParameterCount

protected void checkParameterCount(Collection parameters,
                                   int min,
                                   int max)
            throws InvalidVariableException
Utility method to check parameter counts.
Parameters:
parameters - collection of parameters
min - minimum number of parameters allowed
max - maximum number of parameters allowed
Throws:
InvalidVariableException - if the number of parameters is incorrect

execute

public String execute()
            throws InvalidVariableException

execute

public abstract String execute(SampleResult previousResult,
                               Sampler currentSampler)
            throws InvalidVariableException
N.B. setParameters() and execute() are called from different threads, so both must be synchronized unless there are no parameters to save
Specified by:
execute in interface Function

getReferenceKey

public abstract String getReferenceKey()
Specified by:
getReferenceKey in interface Function

getVariables

protected JMeterVariables getVariables()

setParameters

public abstract void setParameters(Collection parameters)
            throws InvalidVariableException
N.B. setParameters() and execute() are called from different threads, so both must be synchronized unless there are no parameters to save
Specified by:
setParameters in interface Function

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