Package org.apache.juneau.rest.client.assertion

Class FluentResponseStatusLineAssertion<R>

java.lang.Object
org.apache.juneau.assertions.Assertion
org.apache.juneau.assertions.FluentAssertion<R>
org.apache.juneau.assertions.FluentObjectAssertion<StatusLine,R>
org.apache.juneau.rest.client.assertion.FluentResponseStatusLineAssertion<R>
Type Parameters:
R - The return type.
public class FluentResponseStatusLineAssertion<R> extends FluentObjectAssertion<StatusLine,R>
Used for fluent assertion calls against a response StatusLine object.
Example:

// Validates the response status code is 200 or 404. client .get(URI) .run() .assertStatus().asCode().isAny(200,404);

Test Methods

Transform Methods

Configuration Methods

See Also:

  • Constructor Details

    • FluentResponseStatusLineAssertion

      public FluentResponseStatusLineAssertion(StatusLine value, R returns)
      Constructor.
      Parameters:
      value - The object being tested.
      Can be null.
      returns - The object to return after a test method is called.
      If null, the test method returns this object allowing multiple test method calls to be used on the same assertion.

    • FluentResponseStatusLineAssertion

      public FluentResponseStatusLineAssertion(Assertion creator, StatusLine value, R returns)
      Chained constructor.

      Used when transforming one assertion into another so that the assertion config can be used by the new assertion.

      Parameters:
      creator - The assertion that created this assertion.
      Should be null if this is the top-level assertion.
      value - The object being tested.
      Can be null.
      returns - The object to return after a test method is called.
      If null, the test method returns this object allowing multiple test method calls to be used on the same assertion.

  • Method Details

    • asCode

      public FluentIntegerAssertion<R> asCode()
      Returns an assertion against the status code on the response status object.
      Returns:
      An assertion against the status code on the response status object.

    • asReason

      public FluentStringAssertion<R> asReason()
      Returns an assertion against the reason phrase on the response status object.
      Returns:
      An assertion against the reason phrase on the response status object.

    • asProtocol

      public FluentStringAssertion<R> asProtocol()
      Returns an assertion against the protocol on the response status object.
      Returns:
      An assertion against the protocol on the response status object.

    • asMajor

      public FluentIntegerAssertion<R> asMajor()
      Returns an assertion against the protocol major version on the response status object.
      Returns:
      An assertion against the protocol major version on the response status object.

    • asMinor

      public FluentIntegerAssertion<R> asMinor()
      Returns an assertion against the protocol minor version on the response status object.
      Returns:
      An assertion against the protocol minor version on the response status object.

    • setMsg

      public FluentResponseStatusLineAssertion<R> setMsg(String msg, Object... args)
      Description copied from class: Assertion
      Allows you to override the assertion failure message.

      String can contain "{msg}" to represent the original message.

      Example:

      import static org.apache.juneau.assertions.Assertions.*; // Throws an assertion with a custom message instead of the default "Value was null." assertString(myString) .setMsg("My string was bad: {msg}") .isNotNull();

      Overrides:
      setMsg in class FluentObjectAssertion<StatusLine,R>
      Parameters:
      msg - The assertion failure message.
      args - Optional message arguments.
      Returns:
      This object.

    • setOut

      public FluentResponseStatusLineAssertion<R> setOut(PrintStream value)
      Description copied from class: Assertion
      If an error occurs, send the error message to the specified stream instead of STDERR.
      Overrides:
      setOut in class FluentObjectAssertion<StatusLine,R>
      Parameters:
      value - The output stream. Can be null to suppress output.
      Returns:
      This object.

    • setSilent

      public FluentResponseStatusLineAssertion<R> setSilent()
      Description copied from class: Assertion
      Suppresses output to STDERR.

      This is the equivalent to calling out(null).

      Overrides:
      setSilent in class FluentObjectAssertion<StatusLine,R>
      Returns:
      This object.

    • setStdOut

      public FluentResponseStatusLineAssertion<R> setStdOut()
      Description copied from class: Assertion
      If an error occurs, send the error message to STDOUT instead of STDERR.
      Overrides:
      setStdOut in class FluentObjectAssertion<StatusLine,R>
      Returns:
      This object.

    • setThrowable

      public FluentResponseStatusLineAssertion<R> setThrowable(Class<? extends RuntimeException> value)
      Description copied from class: Assertion
      If an error occurs, throw this exception instead of the standard AssertionError.

      The throwable class must have a public constructor that takes in any of the following parameters:

      • Throwable - The caused-by exception (if there is one).
      • String - The assertion failure message.

      If the throwable cannot be instantiated, a RuntimeException is thrown instead.

      Example:

      import static org.apache.juneau.assertions.Assertions.*; // Throws a BadRequest instead of an AssertionError if the string is null. assertString(myString) .setThrowable(BadRequest.class) .isNotNull();

      Overrides:
      setThrowable in class FluentObjectAssertion<StatusLine,R>
      Parameters:
      value - The new value for this setting.
      Returns:
      This object.