DslScopedTestElement (jmeter-java-dsl 1.29 API)

java.lang.Object
- us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement
- - us.abstracta.jmeter.javadsl.core.testelements.DslScopedTestElement<T>

Type Parameters:

T - is the type of the test element that extends this class (to properly inherit fluent API methods).

All Implemented Interfaces:

DslTestElement

Direct Known Subclasses:

DslResponseAssertion, DslVariableExtractor
```
public abstract class DslScopedTestElement<T extends DslScopedTestElement<T>>
extends BaseTestElement
```
Contains common logic for test elements that only process certain samples.

Since:

0.11

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`DslScopedTestElement.Scope`	Specifies to which samples apply the regular extractor to.
`protected static class`	`DslScopedTestElement.ScopedTestElementCallBuilder<T extends org.apache.jmeter.testelement.TestElement>`	Abstracts common logic for `DslScopedTestElement` method call builders.

Field Summary

Fields
Modifier and Type Field Description

protected DslScopedTestElement.Scope scope

protected String scopeVariable
- Fields inherited from class us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement
  guiClass, name

Constructor Summary

Constructors
Modifier Constructor Description

protected DslScopedTestElement(String name, Class<? extends org.apache.jmeter.gui.JMeterGUIComponent> guiClass)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`T`	`scope(DslScopedTestElement.Scope scope)`	Allows specifying if the element should be applied to main sample and/or sub samples.
`T`	`scopeVariable(String scopeVariable)`	Allows specifying that the element should be applied to the contents of a given JMeter variable.
`protected void`	`setScopeTo(org.apache.jmeter.testelement.AbstractScopedTestElement testElement)`

Methods inherited from class us.abstracta.jmeter.javadsl.core.testelements.BaseTestElement
buildConfiguredTestElement, buildTestElement, buildTestElementGui, buildTreeUnder, configureTestElement, durationToSeconds, loadBeanProperties, showAndWaitFrameWith, showFrameWith, showInGui, showTestElementGui

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - scope
```
protected DslScopedTestElement.Scope scope
```
  - scopeVariable
```
protected String scopeVariable
```
- Constructor Detail
  - DslScopedTestElement
```
protected DslScopedTestElement(String name,
                               Class<? extends org.apache.jmeter.gui.JMeterGUIComponent> guiClass)
```
- Method Detail
  - scope
```
public T scope(DslScopedTestElement.Scope scope)
```
    Allows specifying if the element should be applied to main sample and/or sub samples.
    When not specified the element will only apply to main sample.
    
    Parameters:
    
    scope - specifying to what sample result apply the element to.
    
    Returns:
    
    the DSL element for further configuration or usage.
    
    See Also:
    
    DslScopedTestElement.Scope
  - scopeVariable
```
public T scopeVariable(String scopeVariable)
```
    Allows specifying that the element should be applied to the contents of a given JMeter variable.
    This setting overrides any setting on scope and fieldToCheck.
    
    Parameters:
    
    scopeVariable - specifies the name of the variable to apply the element to.
    
    Returns:
    
    the DSL element for further configuration or usage.
  - setScopeTo
```
protected void setScopeTo(org.apache.jmeter.testelement.AbstractScopedTestElement testElement)
```