Package org.apache.juneau.assertions

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

Type Parameters:

T - The object type.

R - The return type.

Direct Known Subclasses:

AnyAssertion

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

Used for assertion calls against generic POJOs.

Extends from FluentObjectAssertion allowing you to perform basic assertions, but adds several transform methods to convert to more-specific assertion types.

Example:

import static org.apache.juneau.assertions.Assertions.*; List<MyBean> listOfBeans = ...; assertList(listOfBeans) .asItem(1) // Returns an AnyAssertion. .asBean() // Transforms to BeanAssertion. .asProperty("foo") // Returns an AnyAssertion. .asString() // Transforms to StringAssertion. .is("bar"); // Performs test.

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:

• FluentAnyAssertion
  • asArray(Class)
  • asIntArray()
  • asLongArray()
  • asShortArray()
  • asFloatArray()
  • asDoubleArray()
  • asCharArray()
  • asByteArray()
  • asBooleanArray()
  • asBoolean()
  • asBytes()
  • asCollection()
  • asCollection(Class)
  • asStringList()
  • asComparable()
  • asDate()
  • asInteger()
  • asLong()
  • asList()
  • asList(Class)
  • asMap()
  • asMap(Class,Class)
  • asBean()
  • asBean(Class)
  • asBeanList(Class)
  • asZonedDateTime()
• 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
FluentAnyAssertion(Assertion creator, T value, R returns)	Chained constructor.
FluentAnyAssertion(T value, R returns)	Constructor.

Method Summary

Modifier and Type	Method	Description
<E> FluentArrayAssertion<E,R>	asArray(Class<E> elementType)	Converts this object assertion into an array assertion.
FluentBeanAssertion<T,R>	asBean()	Converts this object assertion into a bean assertion.
<T2> FluentBeanAssertion<T2,R>	asBean(Class<T2> beanType)	Converts this object assertion into a bean assertion.
<T2> FluentBeanListAssertion<T2,R>	asBeanList(Class<T2> beanType)	Converts this object assertion into a list-of-beans assertion.
FluentBooleanAssertion<R>	asBoolean()	Converts this object assertion into a boolean assertion.
FluentPrimitiveArrayAssertion<Boolean,boolean[],R>	asBooleanArray()	Converts this object assertion into a primitive boolean array assertion.
FluentPrimitiveArrayAssertion<Byte,byte[],R>	asByteArray()	Converts this object assertion into a primitive byte array assertion.
FluentByteArrayAssertion<R>	asBytes()	Converts this object assertion into a byte array assertion.
FluentPrimitiveArrayAssertion<Character,char[],R>	asCharArray()	Converts this object assertion into a primitive char array assertion.
FluentCollectionAssertion<Object,R>	asCollection()	Converts this object assertion into a collection assertion.
<E> FluentCollectionAssertion<E,R>	asCollection(Class<E> elementType)	Converts this object assertion into a collection assertion.
<T2 extends Comparable<T2>> FluentComparableAssertion<T2,R>	asComparable()	Converts this object assertion into a comparable object assertion.
FluentDateAssertion<R>	asDate()	Converts this object assertion into a date assertion.
FluentPrimitiveArrayAssertion<Double,double[],R>	asDoubleArray()	Converts this object assertion into a primitive double array assertion.
FluentPrimitiveArrayAssertion<Float,float[],R>	asFloatArray()	Converts this object assertion into a primitive float array assertion.
FluentPrimitiveArrayAssertion<Integer,int[],R>	asIntArray()	Converts this object assertion into a primitive int array assertion.
FluentIntegerAssertion<R>	asInteger()	Converts this object assertion into an integer assertion.
FluentListAssertion<Object,R>	asList()	Converts this object assertion into a list assertion.
<E> FluentListAssertion<E,R>	asList(Class<E> elementType)	Converts this object assertion into a list assertion.
FluentLongAssertion<R>	asLong()	Converts this object assertion into a long assertion.
FluentPrimitiveArrayAssertion<Long,long[],R>	asLongArray()	Converts this object assertion into a primitive long array assertion.
FluentMapAssertion<String,Object,R>	asMap()	Converts this object assertion into a map assertion.
<K, V> FluentMapAssertion<K,V,R>	asMap(Class<K> keyType, Class<V> valueType)	Converts this object assertion into a map assertion with the specified key and value types.
FluentPrimitiveArrayAssertion<Short,short[],R>	asShortArray()	Converts this object assertion into a primitive short array assertion.
FluentStringListAssertion<R>	asStringList()	Converts this object assertion into a collection assertion.
FluentZonedDateTimeAssertion<R>	asZonedDateTime()	Converts this object assertion into a zoned-datetime assertion.
FluentAnyAssertion<T,R>	setMsg(String msg, Object... args)	Allows you to override the assertion failure message.
FluentAnyAssertion<T,R>	setOut(PrintStream value)	If an error occurs, send the error message to the specified stream instead of STDERR.
FluentAnyAssertion<T,R>	setSilent()	Suppresses output to STDERR.
FluentAnyAssertion<T,R>	setStdOut()	If an error occurs, send the error message to STDOUT instead of STDERR.
FluentAnyAssertion<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, asTransformed, 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, error, error

Methods inherited from class java.lang.Object

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

Constructor Details

FluentAnyAssertion

public FluentAnyAssertion(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.

FluentAnyAssertion

public FluentAnyAssertion(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.

Method Details

asArray

public <E> FluentArrayAssertion<E,R> asArray(Class<E> elementType)
                                      throws AssertionError

Converts this object assertion into an array assertion.

Type Parameters:

E - The element type of the array.

Parameters:

elementType - The element type of the array.

Returns:

A new assertion.

Throws:

AssertionError - If object is not an array.

asBean

public FluentBeanAssertion<T,R> asBean()

Converts this object assertion into a bean assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a bean.

asBean

public <T2> FluentBeanAssertion<T2,R> asBean(Class<T2> beanType)

Converts this object assertion into a bean assertion.

Type Parameters:

T2 - The bean type.

Parameters:

beanType - The bean type.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a bean.

asBeanList

public <T2> FluentBeanListAssertion<T2,R> asBeanList(Class<T2> beanType)

Converts this object assertion into a list-of-beans assertion.

Type Parameters:

T2 - The bean type.

Parameters:

beanType - The bean type.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a bean.

asBoolean

public FluentBooleanAssertion<R> asBoolean()

Converts this object assertion into a boolean assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a boolean.

asBooleanArray

public FluentPrimitiveArrayAssertion<Boolean,boolean[],R> asBooleanArray()
                                                                  throws AssertionError

Converts this object assertion into a primitive boolean array assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not an boolean array.

asByteArray

public FluentPrimitiveArrayAssertion<Byte,byte[],R> asByteArray()
                                                         throws AssertionError

Converts this object assertion into a primitive byte array assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not an byte array.

asBytes

public FluentByteArrayAssertion<R> asBytes()

Converts this object assertion into a byte array assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a byte array.

asCharArray

public FluentPrimitiveArrayAssertion<Character,char[],R> asCharArray()
                                                              throws AssertionError

Converts this object assertion into a primitive char array assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not an char array.

asCollection

public FluentCollectionAssertion<Object,R> asCollection()

Converts this object assertion into a collection assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a collection.

asCollection

public <E> FluentCollectionAssertion<E,R> asCollection(Class<E> elementType)

Converts this object assertion into a collection assertion.

Type Parameters:

E - The element type of the collection.

Parameters:

elementType - The element type of the collection.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a collection.

asComparable

public <T2 extends Comparable<T2>>
FluentComparableAssertion<T2,R> asComparable()

Converts this object assertion into a comparable object assertion.

Type Parameters:

T2 - The comparable type.

Returns:

A new assertion.

Throws:

AssertionError - If object is not an instance of Comparable.

asDate

public FluentDateAssertion<R> asDate()

Converts this object assertion into a date assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a date.

asDoubleArray

public FluentPrimitiveArrayAssertion<Double,double[],R> asDoubleArray()
                                                               throws AssertionError

Converts this object assertion into a primitive double array assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not an double array.

asFloatArray

public FluentPrimitiveArrayAssertion<Float,float[],R> asFloatArray()
                                                            throws AssertionError

Converts this object assertion into a primitive float array assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not an float array.

asIntArray

public FluentPrimitiveArrayAssertion<Integer,int[],R> asIntArray()
                                                          throws AssertionError

Converts this object assertion into a primitive int array assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not an int array.

asInteger

public FluentIntegerAssertion<R> asInteger()

Converts this object assertion into an integer assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not an integer.

asList

public FluentListAssertion<Object,R> asList()

Converts this object assertion into a list assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a list.

asList

public <E> FluentListAssertion<E,R> asList(Class<E> elementType)

Converts this object assertion into a list assertion.

Type Parameters:

E - The element type.

Parameters:

elementType - The element type.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a list.

asLong

public FluentLongAssertion<R> asLong()

Converts this object assertion into a long assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a long.

asLongArray

public FluentPrimitiveArrayAssertion<Long,long[],R> asLongArray()
                                                         throws AssertionError

Converts this object assertion into a primitive long array assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not an long array.

asMap

public FluentMapAssertion<String,Object,R> asMap()

Converts this object assertion into a map assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a map.

asMap

public <K,
V> FluentMapAssertion<K,V,R> asMap(Class<K> keyType,
 Class<V> valueType)

Converts this object assertion into a map assertion with the specified key and value types.

Type Parameters:

K - The key type.

V - The value type.

Parameters:

keyType - The key type.

valueType - The value type.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a map.

asShortArray

public FluentPrimitiveArrayAssertion<Short,short[],R> asShortArray()
                                                            throws AssertionError

Converts this object assertion into a primitive short array assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not an short array.

asStringList

public FluentStringListAssertion<R> asStringList()

Converts this object assertion into a collection assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a collection.

asZonedDateTime

public FluentZonedDateTimeAssertion<R> asZonedDateTime()

Converts this object assertion into a zoned-datetime assertion.

Returns:

A new assertion.

Throws:

AssertionError - If object is not a zoned-datetime.

setMsg

public FluentAnyAssertion<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 FluentAnyAssertion<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 FluentAnyAssertion<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 FluentAnyAssertion<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 FluentAnyAssertion<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.