EscapeHtml (Apache JMeter functions API)

java.lang.Object

org.apache.jmeter.functions.AbstractFunction

org.apache.jmeter.functions.EscapeHtml

All Implemented Interfaces:: org.apache.jmeter.functions.Function

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

Function which escapes the characters in a String using HTML entities.

For example:

"bread" & "butter"

becomes:

"bread" & "butter".

Supports all known HTML 4.0 entities. Note that the commonly used apostrophe escape character (') is not a legal entity and so is not supported).

Since:

2.3.3

See Also:

(Commons Lang)

Constructor Summary

Constructors

Constructor

Description

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