Package org.apache.juneau.assertions

Class BooleanAssertion

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

org.apache.juneau.assertions.BooleanAssertion

public class BooleanAssertion
extends FluentBooleanAssertion<BooleanAssertion>

Used for 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
BooleanAssertion(Boolean value)	Constructor.

Method Summary

Modifier and Type	Method	Description
static BooleanAssertion	create(Boolean value)	Static creator.
BooleanAssertion	setMsg(String msg, Object... args)	Allows you to override the assertion failure message.
BooleanAssertion	setOut(PrintStream value)	If an error occurs, send the error message to the specified stream instead of STDERR.
BooleanAssertion	setSilent()	Suppresses output to STDERR.
BooleanAssertion	setStdOut()	If an error occurs, send the error message to STDOUT instead of STDERR.
BooleanAssertion	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.FluentBooleanAssertion

isFalse, isTrue

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

BooleanAssertion

public BooleanAssertion(Boolean value)

Constructor.

Parameters:

value - The object being tested.
Can be null.

Method Details

create

public static BooleanAssertion create(Boolean value)

Static creator.

Parameters:

value - The object being tested.
Can be null.

Returns:

A new assertion object.

setMsg

public BooleanAssertion 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 FluentBooleanAssertion<BooleanAssertion>

Parameters:

msg - The assertion failure message.

args - Optional message arguments.

Returns:

This object.

setOut

public BooleanAssertion 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 FluentBooleanAssertion<BooleanAssertion>

Parameters:

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

Returns:

This object.

setSilent

public BooleanAssertion setSilent()

Description copied from class: Assertion

Suppresses output to STDERR.

This is the equivalent to calling out(null).

Overrides:

setSilent in class FluentBooleanAssertion<BooleanAssertion>

Returns:

This object.

setStdOut

public BooleanAssertion setStdOut()

Description copied from class: Assertion

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

Overrides:

setStdOut in class FluentBooleanAssertion<BooleanAssertion>

Returns:

This object.

setThrowable

public BooleanAssertion 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 FluentBooleanAssertion<BooleanAssertion>

Parameters:

value - The new value for this setting.

Returns:

This object.