Package org.apache.jmeter.functions

Class FileToString

java.lang.Object

org.apache.jmeter.functions.AbstractFunction

org.apache.jmeter.functions.FileToString

All Implemented Interfaces:

org.apache.jmeter.functions.Function

@AutoService(org.apache.jmeter.functions.Function.class)
public class FileToString
extends org.apache.jmeter.functions.AbstractFunction

FileToString Function to read a complete file into a String.

Parameters:

• file name
• file encoding (optional)
• variable name (optional)

Returns:

• the whole text from a file
• or **ERR** if an error occurs
• value is also optionally saved in the variable for later re-use.

Since:

2.4

Constructor Summary

Constructors

Constructor	Description
FileToString()

Method Summary

Modifier and Type	Method	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 Details

FileToString

public FileToString()

Method Details

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()