org.apache.jmeter.sampler

## Class TestAction

- java.lang.Object
- - org.apache.jmeter.testelement.AbstractTestElement
  - - org.apache.jmeter.samplers.AbstractSampler
    - - org.apache.jmeter.sampler.TestAction

- All Implemented Interfaces:
    Serializable, Cloneable, ConfigMergabilityIndicator, Searchable, Interruptible, Sampler, TestElement

      public class TestAction
      extends AbstractSampler
      implements Interruptible

  Dummy Sampler used to pause or stop a thread or the test; intended for use in Conditional Controllers.
  See Also:
    Serialized Form

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static int` | `BREAK_CURRENT_LOOP` Break Current Loop
    `static int` | `PAUSE`
    `static int` | `RESTART_NEXT_LOOP` Start next iteration of Thread Loop
    `static int` | `START_NEXT_ITERATION_CURRENT_LOOP` Start next iteration of Current Loop
    `static int` | `STOP`
    `static int` | `STOP_NOW`
    `static int` | `TEST`
    `static int` | `THREAD`

    - ### Fields inherited from interface org.apache.jmeter.testelement.TestElement

      `COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `TestAction()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `applies(ConfigTestElement configElement)` Does configElement apply to Sampler
    `int` | `getAction()`
    `String` | `getDurationAsString()`
    `int` | `getTarget()`
    `boolean` | `interrupt()` Interrupt the current operation if possible.
    `SampleResult` | `sample(Entry e)` Obtains statistics about the given Entry, and packages the information into a SampleResult.
    `void` | `setAction(int action)`
    `void` | `setDuration(String duration)`
    `void` | `setTarget(int target)`

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

      `addPropertiesValues, addProperty, addProperty, addTestElement, canRemove, clear, clearTemporary, clearTestElementChildren, clone, emptyTemporary, equals, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getSearchableTokens, getThreadContext, getThreadName, hashCode, isEnabled, isRunningVersion, isTemporary, logProperties, mergeIn, propertyIterator, recoverRunningVersion, removeProperty, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse, traverseCollection, traverseMap, traverseProperty`

    - ### Methods inherited from class java.lang.Object

      `finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface org.apache.jmeter.testelement.TestElement

      `addTestElement, canRemove, clear, clearTestElementChildren, clone, getComment, getName, getProperty, getPropertyAsBoolean, getPropertyAsBoolean, getPropertyAsDouble, getPropertyAsFloat, getPropertyAsInt, getPropertyAsInt, getPropertyAsLong, getPropertyAsLong, getPropertyAsString, getPropertyAsString, getThreadContext, getThreadName, isEnabled, isRunningVersion, isTemporary, propertyIterator, recoverRunningVersion, removed, removeProperty, setComment, setEnabled, setName, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setRunningVersion, setTemporary, setThreadContext, setThreadName, traverse`

- - ### Field Detail

    - #### STOP

          public static final int STOP

      See Also:
        Constant Field Values

    - #### PAUSE

          public static final int PAUSE

      See Also:
        Constant Field Values

    - #### STOP_NOW

          public static final int STOP_NOW

      See Also:
        Constant Field Values

    - #### RESTART_NEXT_LOOP

          public static final int RESTART_NEXT_LOOP

      Start next iteration of Thread Loop
      See Also:
        Constant Field Values

    - #### START_NEXT_ITERATION_CURRENT_LOOP

          public static final int START_NEXT_ITERATION_CURRENT_LOOP

      Start next iteration of Current Loop
      See Also:
        Constant Field Values

    - #### BREAK_CURRENT_LOOP

          public static final int BREAK_CURRENT_LOOP

      Break Current Loop
      See Also:
        Constant Field Values

    - #### THREAD

          public static final int THREAD

      See Also:
        Constant Field Values

    - #### TEST

          public static final int TEST

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### TestAction

          public TestAction()

  - ### Method Detail

    - #### sample

          public SampleResult sample(Entry e)

      Obtains statistics about the given Entry, and packages the information into a SampleResult.
      Specified by:
        `sample` in interface `Sampler`
      Parameters:
        `e` - the Entry (TODO seems to be unused)
      Returns:
        information about the sample

    - #### setTarget

          public void setTarget(int target)

    - #### getTarget

          public int getTarget()

    - #### setAction

          public void setAction(int action)

    - #### getAction

          public int getAction()

    - #### setDuration

          public void setDuration(String duration)

    - #### getDurationAsString

          public String getDurationAsString()

    - #### applies

          public boolean applies(ConfigTestElement configElement)

      Description copied from class: `AbstractSampler`
      Does configElement apply to Sampler
      Specified by:
        `applies` in interface `ConfigMergabilityIndicator`
      Overrides:
        `applies` in class `AbstractSampler`
      Parameters:
        `configElement` - `ConfigTestElement`
      Returns:
        boolean
      See Also:
        `AbstractSampler.applies(org.apache.jmeter.config.ConfigTestElement)`

    - #### interrupt

          public boolean interrupt()

      Description copied from interface: `Interruptible`
      Interrupt the current operation if possible.
      Specified by:
        `interrupt` in interface `Interruptible`
      Returns:
        `true` if there was an operation to interrupt.

Copyright © 1998-2022 Apache Software Foundation. All Rights Reserved.