Package org.apache.juneau.assertions

Class FluentCollectionAssertion<E,R>

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,R>

Type Parameters:

E - The element type.

R - The return type.

Direct Known Subclasses:

CollectionAssertion, FluentListAssertion

public class FluentCollectionAssertion<E,R>
extends FluentObjectAssertion<Collection<E>,R>

Used for fluent assertion calls against collections objects.

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:

• Juneau Ecosystem Overview

Constructor Summary

Constructors

Constructor	Description
FluentCollectionAssertion(Collection<E> value, R returns)	Constructor.
FluentCollectionAssertion(Assertion creator, Collection<E> value, R returns)	Chained constructor.

Method Summary

Modifier and Type	Method	Description
FluentIntegerAssertion<R>	asSize()	Returns an integer assertion on the size of this collection.
FluentStringListAssertion<R>	asStrings()	Converts this assertion into a FluentListAssertion of strings.
FluentCollectionAssertion<E,R>	asTransformed(Function<Collection<E>,Collection<E>> function)	Applies a transform on the inner object and returns a new inner object.
protected int	getSize()	Returns the size of this collection if it is not null.
R	isAll(Predicate<E> test)	Asserts that all values in the collection pass the specified test.
R	isAny(Predicate<E> test)	Asserts that at least one value in the collection passes the specified test.
R	isContains(E entry)	Asserts that the collection contains the expected value.
R	isEmpty()	Asserts that the collection exists and is empty.
R	isNotContains(E entry)	Asserts that the collection contains the expected value.
R	isNotEmpty()	Asserts that the collection exists and is not empty.
R	isSize(int size)	Asserts that the collection exists and is the specified size.
FluentCollectionAssertion<E,R>	setMsg(String msg, Object... args)	Allows you to override the assertion failure message.
FluentCollectionAssertion<E,R>	setOut(PrintStream value)	If an error occurs, send the error message to the specified stream instead of STDERR.
FluentCollectionAssertion<E,R>	setSilent()	Suppresses output to STDERR.
FluentCollectionAssertion<E,R>	setStdOut()	If an error occurs, send the error message to STDOUT instead of STDERR.
FluentCollectionAssertion<E,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

FluentCollectionAssertion

public FluentCollectionAssertion(Collection<E> 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.

FluentCollectionAssertion

public FluentCollectionAssertion(Assertion creator,
 Collection<E> 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 FluentCollectionAssertion<E,R> asTransformed(Function<Collection<E>,Collection<E>> function)

Description copied from class: FluentObjectAssertion

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

Overrides:

asTransformed in class FluentObjectAssertion<Collection<E>,R>

Parameters:

function - The function to apply.

Returns:

This object.

asStrings

public FluentStringListAssertion<R> asStrings()

Converts this assertion into a FluentListAssertion of strings.

Returns:

A new fluent string assertion.

asSize

public FluentIntegerAssertion<R> asSize()

Returns an integer assertion on the size of this collection.

If the collection is null, the returned assertion is a null assertion (meaning FluentObjectAssertion.isExists() returns false).

Returns:

A new assertion.

isEmpty

public R isEmpty()
          throws AssertionError

Asserts that the collection exists and is empty.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed or value was null.

isNotEmpty

public R isNotEmpty()
             throws AssertionError

Asserts that the collection exists and is not empty.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed or value was null.

isContains

public R isContains(E entry)
             throws AssertionError

Asserts that the collection contains the expected value.

Parameters:

entry - The value to check for.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed or value was null.

isNotContains

public R isNotContains(E entry)
                throws AssertionError

Asserts that the collection contains the expected value.

Parameters:

entry - The value to check for.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed or value was null.

isAny

public R isAny(Predicate<E> test)
        throws AssertionError

Asserts that at least one value in the collection passes the specified test.

Parameters:

test - The predicate test.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed or value was null.

isAll

public R isAll(Predicate<E> test)
        throws AssertionError

Asserts that all values in the collection pass the specified test.

Parameters:

test - The predicate test.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed or value was null.

isSize

public R isSize(int size)
         throws AssertionError

Asserts that the collection exists and is the specified size.

Parameters:

size - The expected size.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed or value was null.

setMsg

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

Parameters:

msg - The assertion failure message.

args - Optional message arguments.

Returns:

This object.

setOut

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

Parameters:

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

Returns:

This object.

setSilent

public FluentCollectionAssertion<E,R> setSilent()

Description copied from class: Assertion

Suppresses output to STDERR.

This is the equivalent to calling out(null).

Overrides:

setSilent in class FluentObjectAssertion<Collection<E>,R>

Returns:

This object.

setStdOut

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

Returns:

This object.

setThrowable

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

Parameters:

value - The new value for this setting.

Returns:

This object.

getSize

protected int getSize()
               throws AssertionError

Returns the size of this collection if it is not null.

Returns:

the size of this collection if it is not null.

Throws:

AssertionError - If value was null.