Class AssertionResult

    • Constructor Detail

      • AssertionResult

        @Deprecated
        public AssertionResult()
        Deprecated.
        - use the named constructor
        Create a new Assertion Result. The result will indicate no failure or error.
      • AssertionResult

        public AssertionResult​(String name)
        Create a new Assertion Result. The result will indicate no failure or error.
        Parameters:
        name - the name of the assertion
    • Method Detail

      • getName

        public String getName()
        Get the name of the assertion
        Returns:
        the name of the assertion
      • isFailure

        public boolean isFailure()
        Check if the assertion failed. If it failed, the failure message may give more details about the failure.
        Returns:
        true if the assertion failed, false if the sample met the assertion criteria
      • isError

        public boolean isError()
        Check if an error occurred while checking the assertion. If an error occurred, the failure message may give more details about the error.
        Returns:
        true if an error occurred while checking the assertion, false otherwise.
      • getFailureMessage

        public String getFailureMessage()
        Get the message associated with any failure or error. This method may return null if no message was set.
        Returns:
        a failure or error message, or null if no message has been set
      • setError

        public void setError​(boolean e)
        Set the flag indicating whether or not an error occurred.
        Parameters:
        e - true if an error occurred, false otherwise
      • setFailure

        public void setFailure​(boolean f)
        Set the flag indicating whether or not a failure occurred.
        Parameters:
        f - true if a failure occurred, false otherwise
      • setFailureMessage

        public void setFailureMessage​(String message)
        Set the failure message giving more details about a failure or error.
        Parameters:
        message - the message to set
      • setResultForFailure

        public AssertionResult setResultForFailure​(String message)
        Convenience method for setting up failed results
        Parameters:
        message - the message to set
        Returns:
        this
      • setResultForNull

        public AssertionResult setResultForNull()
        Convenience method for setting up results where the response was null
        Returns:
        assertion result with appropriate fields set up