All Implemented Interfaces:

java.io.Serializable , java.lang.Cloneable , org.apache.jmeter.gui.Searchable , org.apache.jmeter.processor.PostProcessor , org.apache.jmeter.testelement.TestElement
```
public class RegexExtractor
extends AbstractScopedTestElement implements PostProcessor, Serializable
                    
```

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public final static String`	`USE_HDRS`
`public final static String`	`USE_REQUEST_HDRS`
`public final static String`	`USE_BODY`
`public final static String`	`USE_BODY_UNESCAPED`
`public final static String`	`USE_BODY_AS_DOCUMENT`
`public final static String`	`USE_URL`
`public final static String`	`USE_CODE`
`public final static String`	`USE_MESSAGE`
`public transient JMeterContext`	`threadContext`
`public transient String`	`threadName`
`public final static TestElement.Companion`	`Companion`
`public final static String`	`NAME`
`public final static String`	`GUI_CLASS`
`public final static String`	`ENABLED`
`public final static String`	`TEST_CLASS`
`public final static String`	`COMMENTS`

Constructor Summary

Constructors
Constructor	Description
`RegexExtractor()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`RegexExtractorSchema`	`getSchema()`
`PropertiesAccessor<out RegexExtractor, out RegexExtractorSchema>`	`getProps()`
`void`	`process()`	Parses the response data using regular expressions and saving the results into variables for use later in the test.
`void`	`setRegex(String regex)`	Set the regex to be used
`String`	`getRegex()`	Get the regex which is to be used
`void`	`setRefName(String refName)`	Set the prefix name of the variable to be used to store the regex matches
`String`	`getRefName()`	Get the prefix name of the variable to be used to store the regex matches
`void`	`setMatchNumber(int matchNumber)`	Set which Match to use.
`void`	`setMatchNumber(String matchNumber)`
`int`	`getMatchNumber()`
`String`	`getMatchNumberAsString()`
`void`	`setDefaultValue(String defaultValue)`	Sets the value of the variable if no matches are found
`void`	`setDefaultEmptyValue(boolean defaultEmptyValue)`	Set default value to "" value when if it's empty
`String`	`getDefaultValue()`	Get the default value for the variable, which should be used, if no matches are found
`boolean`	`isEmptyDefaultValue()`	Do we set default value to "" value when if it's empty
`void`	`setTemplate(String template)`
`String`	`getTemplate()`
`boolean`	`useHeaders()`
`boolean`	`useRequestHeaders()`
`boolean`	`useBody()`
`boolean`	`useUnescapedBody()`
`boolean`	`useBodyAsDocument()`
`boolean`	`useUrl()`
`boolean`	`useCode()`
`boolean`	`useMessage()`
`void`	`setUseField(String actionCommand)`

Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement
addTestElement, canRemove, clear, clearTestElementChildren, clone, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsLong, getPropertyAsString, getPropertyOrNull, getSearchableTokens, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, propertyIterator, recoverRunningVersion, removeProperty, setComment, setEnabled, setName, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse
Methods inherited from class org.apache.jmeter.testelement.AbstractScopedTestElement
fetchScope, getVariableName, isScopeAll, isScopeChildren, isScopeParent, isScopeVariable, setScopeAll, setScopeChildren, setScopeParent, setScopeVariable
Methods inherited from class org.apache.jmeter.testelement.TestElement
get, get, get, get, get, get, get, get, get, getOrCreate, getOrCreate, getOrNull, getOrNull, getOrNull, getProps, getSchema, getString, removed, set
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RegexExtractor
```
RegexExtractor()
```
- Method Detail
  - getSchema
```
 RegexExtractorSchema getSchema()
```
  - getProps
```
 PropertiesAccessor<out RegexExtractor, out RegexExtractorSchema> getProps()
```
  - process
```
 void process()
```
    Parses the response data using regular expressions and saving the results into variables for use later in the test.
  - setRegex
```
 void setRegex(String regex)
```
    Set the regex to be used
    
    Parameters:
    
    regex - The string representation of the regex
  - getRegex
```
 String getRegex()
```
    Get the regex which is to be used
  - setRefName
```
 void setRefName(String refName)
```
    Set the prefix name of the variable to be used to store the regex matches
    
    Parameters:
    
    refName - prefix of the variables to be used
  - getRefName
```
 String getRefName()
```
    Get the prefix name of the variable to be used to store the regex matches
  - setMatchNumber
```
 void setMatchNumber(int matchNumber)
```
    Set which Match to use. This can be any positive number, indicating the exact match to use, or 0, which is interpreted as meaning random.
    
    Parameters:
    
    matchNumber - The number of the match to be used, or 0 if a random match should be used.
  - setMatchNumber
```
 void setMatchNumber(String matchNumber)
```
  - getMatchNumber
```
 int getMatchNumber()
```
  - getMatchNumberAsString
```
 String getMatchNumberAsString()
```
  - setDefaultValue
```
 void setDefaultValue(String defaultValue)
```
    Sets the value of the variable if no matches are found
    
    Parameters:
    
    defaultValue - The default value for the variable
  - setDefaultEmptyValue
```
 void setDefaultEmptyValue(boolean defaultEmptyValue)
```
    Set default value to "" value when if it's empty
    
    Parameters:
    
    defaultEmptyValue - The default value for the variable
  - getDefaultValue
```
 String getDefaultValue()
```
    Get the default value for the variable, which should be used, if no matches are found
  - isEmptyDefaultValue
```
 boolean isEmptyDefaultValue()
```
    Do we set default value to "" value when if it's empty
  - setTemplate
```
 void setTemplate(String template)
```
  - getTemplate
```
 String getTemplate()
```
  - useHeaders
```
 boolean useHeaders()
```
  - useRequestHeaders
```
 boolean useRequestHeaders()
```
  - useBody
```
 boolean useBody()
```
  - useUnescapedBody
```
 boolean useUnescapedBody()
```
  - useBodyAsDocument
```
 boolean useBodyAsDocument()
```
  - useUrl
```
 boolean useUrl()
```
  - useCode
```
 boolean useCode()
```
  - useMessage
```
 boolean useMessage()
```
  - setUseField
```
 void setUseField(String actionCommand)
```

Class RegexExtractor

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class org.apache.jmeter.testelement.AbstractTestElement

Methods inherited from class org.apache.jmeter.testelement.AbstractScopedTestElement

Methods inherited from class org.apache.jmeter.testelement.TestElement

Methods inherited from class java.lang.Object

Constructor Detail

RegexExtractor

Method Detail

getSchema

getProps

process

setRegex

getRegex

setRefName

getRefName

setMatchNumber

setMatchNumber

getMatchNumber

getMatchNumberAsString

setDefaultValue

setDefaultEmptyValue

getDefaultValue

isEmptyDefaultValue

setTemplate

getTemplate

useHeaders

useRequestHeaders

useBody

useUnescapedBody

useBodyAsDocument

useUrl

useCode

useMessage

setUseField