org.apache.jmeter.assertions

## Class SizeAssertion

- java.lang.Object
- - org.apache.jmeter.testelement.AbstractTestElement
  - - org.apache.jmeter.testelement.AbstractScopedTestElement
    - - org.apache.jmeter.testelement.AbstractScopedAssertion
      - - org.apache.jmeter.assertions.SizeAssertion

- All Implemented Interfaces:
    Serializable, Cloneable, Assertion, Searchable, TestElement

      public class SizeAssertion
      extends AbstractScopedAssertion
      implements Serializable, Assertion

  Checks if the results of a Sample matches a particular size.
  See Also:
    Serialized Form

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static int` | `EQUAL`
    `static int` | `GREATERTHAN`
    `static int` | `GREATERTHANEQUAL`
    `static int` | `LESSTHAN`
    `static int` | `LESSTHANEQUAL`
    `static int` | `NOTEQUAL`

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

      `COMMENTS, ENABLED, GUI_CLASS, NAME, TEST_CLASS`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `SizeAssertion()`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getAllowedSize()` Returns the size in bytes to be asserted.
    `int` | `getCompOper()` Returns the operator to be asserted.
    `AssertionResult` | `getResult(SampleResult response)` Returns the result of the Assertion.
    `String` | `getTestField()`
    `boolean` | `isTestFieldNetworkSize()`
    `boolean` | `isTestFieldResponseBody()`
    `boolean` | `isTestFieldResponseCode()`
    `boolean` | `isTestFieldResponseHeaders()`
    `boolean` | `isTestFieldResponseMessage()`
    `void` | `setAllowedSize(long size)` Set the size that should be used in the assertion
    `void` | `setAllowedSize(String size)` Set the size that shall be asserted.
    `void` | `setCompOper(int operator)` Set the operator used for the assertion.
    `void` | `setTestFieldNetworkSize()`
    `void` | `setTestFieldResponseBody()`
    `void` | `setTestFieldResponseCode()`
    `void` | `setTestFieldResponseHeaders()`
    `void` | `setTestFieldResponseMessage()`

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

      `getScopeName`

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

      `fetchScope, getSampleList, getVariableName, isScopeAll, isScopeChildren, isScopeParent, isScopeVariable, isScopeVariable, setScopeAll, setScopeChildren, setScopeParent, setScopeVariable`

    - ### 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

      `removed`

- - ### Field Detail

    - #### EQUAL

          public static final int EQUAL

      See Also:
        Constant Field Values

    - #### NOTEQUAL

          public static final int NOTEQUAL

      See Also:
        Constant Field Values

    - #### GREATERTHAN

          public static final int GREATERTHAN

      See Also:
        Constant Field Values

    - #### LESSTHAN

          public static final int LESSTHAN

      See Also:
        Constant Field Values

    - #### GREATERTHANEQUAL

          public static final int GREATERTHANEQUAL

      See Also:
        Constant Field Values

    - #### LESSTHANEQUAL

          public static final int LESSTHANEQUAL

      See Also:
        Constant Field Values

  - ### Constructor Detail

    - #### SizeAssertion

          public SizeAssertion()

  - ### Method Detail

    - #### getResult

          public AssertionResult getResult(SampleResult response)

      Returns the result of the Assertion. Here it checks the Sample responseData length.
      Specified by:
        `getResult` in interface `Assertion`
      Parameters:
        `response` - the SampleResult containing information about the Sample (duration, success, etc)
      Returns:
        the AssertionResult containing the information about whether the assertion passed or failed.

    - #### getAllowedSize

          public String getAllowedSize()

      Returns the size in bytes to be asserted.
      Returns:
        The allowed size

    - #### setCompOper

          public void setCompOper(int operator)

      Set the operator used for the assertion. Has to be one of
      EQUAL
        1
      NOTEQUAL
        2
      GREATERTHAN
        3
      LESSTHAN
        4
      GREATERTHANEQUAL
        5
      LESSTHANEQUAL
        6
      Parameters:
        `operator` - The operator to be used in the assertion

    - #### getCompOper

          public int getCompOper()

      Returns the operator to be asserted.
      EQUAL
        1
      NOTEQUAL
        2
      GREATERTHAN
        3
      LESSTHAN
        4
      GREATERTHANEQUAL
        5
      LESSTHANEQUAL
        6
      Returns:
        The operator used for the assertion

    - #### setAllowedSize

          public void setAllowedSize(String size)

      Set the size that shall be asserted.
      Parameters:
        `size` - a number of bytes.

    - #### setAllowedSize

          public void setAllowedSize(long size)

      Set the size that should be used in the assertion
      Parameters:
        `size` - The number of bytes

    - #### setTestFieldNetworkSize

          public void setTestFieldNetworkSize()

    - #### setTestFieldResponseHeaders

          public void setTestFieldResponseHeaders()

    - #### setTestFieldResponseBody

          public void setTestFieldResponseBody()

    - #### setTestFieldResponseCode

          public void setTestFieldResponseCode()

    - #### setTestFieldResponseMessage

          public void setTestFieldResponseMessage()

    - #### getTestField

          public String getTestField()

    - #### isTestFieldNetworkSize

          public boolean isTestFieldNetworkSize()

    - #### isTestFieldResponseHeaders

          public boolean isTestFieldResponseHeaders()

    - #### isTestFieldResponseBody

          public boolean isTestFieldResponseBody()

    - #### isTestFieldResponseCode

          public boolean isTestFieldResponseCode()

    - #### isTestFieldResponseMessage

          public boolean isTestFieldResponseMessage()

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