Package org.apache.juneau.assertions

Class FluentBooleanAssertion<R>

java.lang.Object

org.apache.juneau.assertions.Assertion

org.apache.juneau.assertions.FluentAssertion<R>

org.apache.juneau.assertions.FluentObjectAssertion<T,R>

org.apache.juneau.assertions.FluentComparableAssertion<Boolean,R>

org.apache.juneau.assertions.FluentBooleanAssertion<R>

Type Parameters:

R - The return type.

Direct Known Subclasses:

BooleanAssertion

public class FluentBooleanAssertion<R>
extends FluentComparableAssertion<Boolean,R>

Used for fluent assertion calls against booleans.

Test Methods:

• FluentBooleanAssertion
  • isTrue()
  • isFalse()
• FluentComparableAssertion
  • isGt(Comparable)
  • isGte(Comparable)
  • isLt(Comparable)
  • isLte(Comparable)
  • isBetween(Comparable,Comparable)
• FluentObjectAssertion
  • isExists()
  • is(Object)
  • is(Predicate)
  • isNot(Object)
  • isAny(Object...)
  • isNotAny(Object...)
  • isNull()
  • isNotNull()
  • isString(String)
  • isJson(String)
  • isSame(Object)
  • isSameJsonAs(Object)
  • isSameSortedJsonAs(Object)
  • isSameSerializedAs(Object, WriterSerializer)
  • isType(Class)
  • isExactType(Class)

Transform Methods:

• FluentObjectAssertion
  • asString()
  • asString(WriterSerializer)
  • asString(Function)
  • asJson()
  • asJsonSorted()
  • asApplied(Function)
  • asAny()

Configuration Methods:

• Assertion
  • setMsg(String, Object...)
  • setOut(PrintStream)
  • setSilent()
  • setStdOut()
  • setThrowable(Class)

See Also:

• Overview > juneau-assertions > Overview

Constructor Summary

Constructors

Constructor	Description
FluentBooleanAssertion(Boolean value, R returns)	Constructor.
FluentBooleanAssertion(Assertion creator, Boolean value, R returns)	Chained constructor.

Method Summary

Modifier and Type	Method	Description
R	isFalse()	Asserts that the value is false.
R	isTrue()	Asserts that the value is true.
FluentBooleanAssertion<R>	setMsg(String msg, Object... args)	Allows you to override the assertion failure message.
FluentBooleanAssertion<R>	setOut(PrintStream value)	If an error occurs, send the error message to the specified stream instead of STDERR.
FluentBooleanAssertion<R>	setSilent()	Suppresses output to STDERR.
FluentBooleanAssertion<R>	setStdOut()	If an error occurs, send the error message to STDOUT instead of STDERR.
FluentBooleanAssertion<R>	setThrowable(Class<? extends RuntimeException> value)	If an error occurs, throw this exception instead of the standard AssertionError.

Methods inherited from class org.apache.juneau.assertions.FluentComparableAssertion

asTransformed, isBetween, isGt, isGte, isLt, isLte

Methods inherited from class org.apache.juneau.assertions.FluentObjectAssertion

asAny, asJson, asJsonSorted, asString, asString, asString, asTransformedTo, equals, getFailureMessage, is, is, isAny, isExactType, isExists, isJson, isNot, isNotAny, isNotNull, isNull, isSame, isSameJsonAs, isSameSerializedAs, isSameSortedJsonAs, isString, isType, map, opt, orElse, toString, value, valueAsString, valueIsNotNull, valueIsNull

Methods inherited from class org.apache.juneau.assertions.FluentAssertion

returns

Methods inherited from class org.apache.juneau.assertions.Assertion

arrayClass, className, error, error

Methods inherited from class java.lang.Object

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

Constructor Details

FluentBooleanAssertion

public FluentBooleanAssertion(Boolean 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.

FluentBooleanAssertion

public FluentBooleanAssertion(Assertion creator,
 Boolean 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

isTrue

public R isTrue()
         throws AssertionError

Asserts that the value is true.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed.

isFalse

public R isFalse()
          throws AssertionError

Asserts that the value is false.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed.

setMsg

public FluentBooleanAssertion<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 FluentComparableAssertion<Boolean,R>

Parameters:

msg - The assertion failure message.

args - Optional message arguments.

Returns:

This object.

setOut

public FluentBooleanAssertion<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 FluentComparableAssertion<Boolean,R>

Parameters:

value - The output stream. Can be null to suppress output.

Returns:

This object.

setSilent

public FluentBooleanAssertion<R> setSilent()

Description copied from class: Assertion

Suppresses output to STDERR.

This is the equivalent to calling out(null).

Overrides:

setSilent in class FluentComparableAssertion<Boolean,R>

Returns:

This object.

setStdOut

public FluentBooleanAssertion<R> setStdOut()

Description copied from class: Assertion

If an error occurs, send the error message to STDOUT instead of STDERR.

Overrides:

setStdOut in class FluentComparableAssertion<Boolean,R>

Returns:

This object.

setThrowable

public FluentBooleanAssertion<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 FluentComparableAssertion<Boolean,R>

Parameters:

value - The new value for this setting.

Returns:

This object.