Package org.apache.juneau.assertions

Class CollectionAssertion<E>

java.lang.Object

org.apache.juneau.assertions.Assertion

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

org.apache.juneau.assertions.FluentObjectAssertion<Collection<E>,R>

org.apache.juneau.assertions.FluentCollectionAssertion<E,CollectionAssertion<E>>

org.apache.juneau.assertions.CollectionAssertion<E>

Type Parameters:

E - The element type.

public class CollectionAssertion<E>
extends FluentCollectionAssertion<E,CollectionAssertion<E>>

Used for assertion calls against collections objects.

Example:

// Validates the specified list is not empty. assertCollection(myList).isNotEmpty();

Test Methods:

• FluentCollectionAssertion
  • isEmpty()
  • isNotEmpty()
  • isContains(Object)
  • isNotContains(Object)
  • isAny(Predicate)
  • isAll(Predicate)
  • isSize(int size)
• 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:

• FluentCollectionAssertion
  • asStrings()
  • asSize()
• 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
CollectionAssertion(Collection<E> value)	Constructor.

Method Summary

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

asSize, asStrings, asTransformed, getSize, isAll, isAny, isContains, isEmpty, isNotContains, isNotEmpty, isSize

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

CollectionAssertion

public CollectionAssertion(Collection<E> value)

Constructor.

Parameters:

value - The object being tested.
Can be null.

Method Details

create

public static <E> CollectionAssertion<E> create(Collection<E> value)

Static creator.

Type Parameters:

E - The element type.

Parameters:

value - The object being tested.
Can be null.

Returns:

A new assertion object.

setMsg

public CollectionAssertion<E> 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 FluentCollectionAssertion<E,CollectionAssertion<E>>

Parameters:

msg - The assertion failure message.

args - Optional message arguments.

Returns:

This object.

setOut

public CollectionAssertion<E> 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 FluentCollectionAssertion<E,CollectionAssertion<E>>

Parameters:

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

Returns:

This object.

setSilent

public CollectionAssertion<E> setSilent()

Description copied from class: Assertion

Suppresses output to STDERR.

This is the equivalent to calling out(null).

Overrides:

setSilent in class FluentCollectionAssertion<E,CollectionAssertion<E>>

Returns:

This object.

setStdOut

public CollectionAssertion<E> setStdOut()

Description copied from class: Assertion

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

Overrides:

setStdOut in class FluentCollectionAssertion<E,CollectionAssertion<E>>

Returns:

This object.

setThrowable

public CollectionAssertion<E> 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 FluentCollectionAssertion<E,CollectionAssertion<E>>

Parameters:

value - The new value for this setting.

Returns:

This object.