Package org.apache.juneau.assertions

Class FluentBeanAssertion<T,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.FluentBeanAssertion<T,R>

Type Parameters:

T - The bean type.

R - The return type.

Direct Known Subclasses:

BeanAssertion

public class FluentBeanAssertion<T,R>
extends FluentObjectAssertion<T,R>

Used for fluent assertion calls against Java beans.

Test Methods:

• 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:

• FluentBeanAssertion
  • asPropertyMap(String...)
  • asProperty(String)
  • asProperties(String...)
• 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:

• Juneau Ecosystem Overview

Constructor Summary

Constructors

Constructor	Description
FluentBeanAssertion(Assertion creator, T value, R returns)	Chained constructor.
FluentBeanAssertion(T value, R returns)	Constructor.

Method Summary

Modifier and Type	Method	Description
FluentListAssertion<Object,R>	asProperties(String... names)	Extracts the specified property as an FluentListAssertion.
FluentAnyAssertion<Object,R>	asProperty(String name)	Extracts the specified property as an FluentAnyAssertion.
FluentMapAssertion<String,Object,R>	asPropertyMap(String... names)	Extracts the specified fields of this bean into a simple map of key/value pairs and returns it as a new MapAssertion.
FluentBeanAssertion<T,R>	asTransformed(Function<T,T> function)	Applies a transform on the inner object and returns a new inner object.
FluentBeanAssertion<T,R>	setMsg(String msg, Object... args)	Allows you to override the assertion failure message.
FluentBeanAssertion<T,R>	setOut(PrintStream value)	If an error occurs, send the error message to the specified stream instead of STDERR.
FluentBeanAssertion<T,R>	setSilent()	Suppresses output to STDERR.
FluentBeanAssertion<T,R>	setStdOut()	If an error occurs, send the error message to STDOUT instead of STDERR.
FluentBeanAssertion<T,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.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

FluentBeanAssertion

public FluentBeanAssertion(T 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.

FluentBeanAssertion

public FluentBeanAssertion(Assertion creator,
 T 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

asTransformed

public FluentBeanAssertion<T,R> asTransformed(Function<T,T> function)

Description copied from class: FluentObjectAssertion

Applies a transform on the inner object and returns a new inner object.

Overrides:

asTransformed in class FluentObjectAssertion<T,R>

Parameters:

function - The function to apply.

Returns:

This object.

asPropertyMap

public FluentMapAssertion<String,Object,R> asPropertyMap(String... names)

Extracts the specified fields of this bean into a simple map of key/value pairs and returns it as a new MapAssertion.

Parameters:

names - The fields to extract. Can also pass in comma-delimited lists.

Returns:

This object.

asProperty

public FluentAnyAssertion<Object,R> asProperty(String name)

Extracts the specified property as an FluentAnyAssertion.

Parameters:

name - The property to extract. Can also pass in comma-delimited lists.

Returns:

An assertion of the property value.

asProperties

public FluentListAssertion<Object,R> asProperties(String... names)

Extracts the specified property as an FluentListAssertion.

Parameters:

names - The names of the properties to extract. Can also pass in comma-delimited lists.

Returns:

An assertion of the property values.

setMsg

public FluentBeanAssertion<T,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<T,R>

Parameters:

msg - The assertion failure message.

args - Optional message arguments.

Returns:

This object.

setOut

public FluentBeanAssertion<T,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<T,R>

Parameters:

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

Returns:

This object.

setSilent

public FluentBeanAssertion<T,R> setSilent()

Description copied from class: Assertion

Suppresses output to STDERR.

This is the equivalent to calling out(null).

Overrides:

setSilent in class FluentObjectAssertion<T,R>

Returns:

This object.

setStdOut

public FluentBeanAssertion<T,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<T,R>

Returns:

This object.

setThrowable

public FluentBeanAssertion<T,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<T,R>

Parameters:

value - The new value for this setting.

Returns:

This object.