org.apache.jmeter.threads

## Class SamplePackage

- java.lang.Object
- - org.apache.jmeter.threads.SamplePackage

-     public class SamplePackage
      extends Object

  Packages methods related to sample handling.
  A SamplePackage contains all elements associated to a Sampler:
  - SampleListener(s)
  - Timer(s)
  - Assertion(s)
  - PreProcessor(s)
  - PostProcessor(s)
  - ConfigTestElement(s)
  - Controller(s)

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `SamplePackage(List<ConfigTestElement> configs, List<SampleListener> listeners, List<Timer> timers, List<Assertion> assertions, List<PostProcessor> postProcessors, List<PreProcessor> preProcessors, List<Controller> controllers)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addAssertion(Assertion asser)` Add Assertion
    `void` | `addPostProcessor(PostProcessor ex)` Add Post processor
    `void` | `addPreProcessor(PreProcessor pre)` Add Pre processor
    `void` | `addSampleListener(SampleListener listener)` Add Sample Listener
    `void` | `addTimer(Timer timer)` Add Timer
    `List<Assertion>` | `getAssertions()`
    `List<ConfigTestElement>` | `getConfigs()` Returns the configs.
    `List<PostProcessor>` | `getPostProcessors()`
    `List<PreProcessor>` | `getPreProcessors()` Returns the preProcessors.
    `List<SampleListener>` | `getSampleListeners()`
    `Sampler` | `getSampler()`
    `List<Timer>` | `getTimers()`
    `void` | `recoverRunningVersion()` Recover each member of SamplePackage to the state before the call of setRunningVersion(true)
    `void` | `setRunningVersion(boolean running)` Make the SamplePackage the running version, or make it no longer the running version.
    `void` | `setSampler(Sampler s)`

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

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### SamplePackage

          public SamplePackage(List<ConfigTestElement> configs,
                               List<SampleListener> listeners,
                               List<Timer> timers,
                               List<Assertion> assertions,
                               List<PostProcessor> postProcessors,
                               List<PreProcessor> preProcessors,
                               List<Controller> controllers)

  - ### Method Detail

    - #### setRunningVersion

          public void setRunningVersion(boolean running)

      Make the SamplePackage the running version, or make it no longer the running version. This tells to each element of the SamplePackage that it's current state must be retrievable by a call to recoverRunningVersion().
      Parameters:
        `running` - boolean
      See Also:
        `TestElement.setRunningVersion(boolean)`

    - #### recoverRunningVersion

          public void recoverRunningVersion()

      Recover each member of SamplePackage to the state before the call of setRunningVersion(true)
      See Also:
        `TestElement.recoverRunningVersion()`

    - #### getSampleListeners

          public List<SampleListener> getSampleListeners()

      Returns:
        List of `SampleListener`s

    - #### addSampleListener

          public void addSampleListener(SampleListener listener)

      Add Sample Listener
      Parameters:
        `listener` - `SampleListener`

    - #### getTimers

          public List<Timer> getTimers()

      Returns:
        List of `Timer`s

    - #### addPostProcessor

          public void addPostProcessor(PostProcessor ex)

      Add Post processor
      Parameters:
        `ex` - `PostProcessor`

    - #### addPreProcessor

          public void addPreProcessor(PreProcessor pre)

      Add Pre processor
      Parameters:
        `pre` - `PreProcessor`

    - #### addTimer

          public void addTimer(Timer timer)

      Add Timer
      Parameters:
        `timer` - `Timer`

    - #### addAssertion

          public void addAssertion(Assertion asser)

      Add Assertion
      Parameters:
        `asser` - `Assertion`

    - #### getAssertions

          public List<Assertion> getAssertions()

      Returns:
        List of `Assertion`

    - #### getPostProcessors

          public List<PostProcessor> getPostProcessors()

      Returns:
        List of `PostProcessor`s

    - #### getSampler

          public Sampler getSampler()

      Returns:
        `Sampler`

    - #### setSampler

          public void setSampler(Sampler s)

      Parameters:
        `s` - `Sampler`

    - #### getPreProcessors

          public List<PreProcessor> getPreProcessors()

      Returns the preProcessors.
      Returns:
        List of `PreProcessor`

    - #### getConfigs

          public List<ConfigTestElement> getConfigs()

      Returns the configs.
      Returns:
        List of `ConfigTestElement`

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