org.apache.jmeter.functions

Class LogFunction

java.lang.Object

org.apache.jmeter.functions.AbstractFunction

org.apache.jmeter.functions.LogFunction

All Implemented Interfaces:

org.apache.jmeter.functions.Function

public class LogFunction
extends org.apache.jmeter.functions.AbstractFunction

Function to log a message.

Parameters:

• string value
• log level (optional; defaults to INFO; or DEBUG if unrecognised; or can use OUT or ERR)
• throwable message (optional)
• comment (optional)

Returns: - the input string

Since:

2.2

Constructor Summary

Constructors

Constructor and Description
LogFunction()

Method Summary

Modifier and Type	Method and Description
String	execute(org.apache.jmeter.samplers.SampleResult previousResult, org.apache.jmeter.samplers.Sampler currentSampler)
List<String>	getArgumentDesc()
String	getReferenceKey()
void	setParameters(Collection<org.apache.jmeter.engine.util.CompoundVariable> parameters)

Methods inherited from class org.apache.jmeter.functions.AbstractFunction

addVariableValue, 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

LogFunction

public LogFunction()

Method Detail

execute

public String execute(org.apache.jmeter.samplers.SampleResult previousResult,
                      org.apache.jmeter.samplers.Sampler currentSampler)
               throws org.apache.jmeter.functions.InvalidVariableException

Specified by:

execute in interface org.apache.jmeter.functions.Function

Specified by:

execute in class org.apache.jmeter.functions.AbstractFunction

Throws:

org.apache.jmeter.functions.InvalidVariableException

setParameters

public void setParameters(Collection<org.apache.jmeter.engine.util.CompoundVariable> parameters)
                   throws org.apache.jmeter.functions.InvalidVariableException

Specified by:

setParameters in interface org.apache.jmeter.functions.Function

Specified by:

setParameters in class org.apache.jmeter.functions.AbstractFunction

Throws:

org.apache.jmeter.functions.InvalidVariableException

getReferenceKey

public String getReferenceKey()

Specified by:

getReferenceKey in interface org.apache.jmeter.functions.Function

Specified by:

getReferenceKey in class org.apache.jmeter.functions.AbstractFunction

getArgumentDesc

public List<String> getArgumentDesc()