Package org.apache.juneau.assertions

Class FluentListAssertion<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>

org.apache.juneau.assertions.FluentListAssertion<E,R>

Type Parameters:

E - The element type.

R - The return type.

Direct Known Subclasses:

FluentBeanListAssertion, FluentStringListAssertion, ListAssertion

public class FluentListAssertion<E,R>
extends FluentCollectionAssertion<E,R>

Used for fluent assertion calls against lists.

Test Methods:

• FluentListAssertion
  • isHas(Object...)
  • isEach(Predicate...)
• 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:

• FluentListAssertion
  • asStrings()
  • asStrings(Function)
  • asCdl()
  • asCdl(Function)
  • asItem(int)
  • asSorted()
  • asSorted(Comparator)
• 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
FluentListAssertion(List<E> value, R returns)	Constructor.
FluentListAssertion(Assertion creator, List<E> value, R returns)	Chained constructor.

Method Summary

Modifier and Type	Method	Description
FluentListAssertion<E,R>	asApplied2(Function<List<E>,List<E>> function)	Applies a transform on the inner object and returns a new inner object.
FluentStringAssertion<R>	asCdl()	Converts the entries in this list to a simple comma-delimited list and returns the value as a fluent string assertion.
FluentStringAssertion<R>	asCdl(Function<E,String> function)	Converts the entries to strings using the specified stringify function, combines them into a simple comma-delimited list, and returns the value as a fluent string assertion.
FluentAnyAssertion<E,R>	asFirst()	Returns the first entry from this list.
FluentListAssertion<E,R>	asFirst(int count)	Returns the first X number of entries from this list.
FluentAnyAssertion<E,R>	asItem(int index)	Returns an object assertion on the item specified at the specified index.
FluentAnyAssertion<E,R>	asLast()	Returns the last entry from this list.
FluentListAssertion<E,R>	asLast(int count)	Returns the first X number of entries from this list.
FluentListAssertion<E,R>	asSorted()	Sorts the entries in this list.
FluentListAssertion<E,R>	asSorted(Comparator<E> comparator)	Sorts the entries in this list using the specified comparator.
FluentStringListAssertion<R>	asStrings(Function<E,String> function)	Runs the stringify function against all values in this list and returns it as a fluent string list assertion.
FluentListAssertion<E,R>	asSublist(int start, int end)	Returns a sublist of the entries in this list.
final R	isEach(Predicate<E>... tests)	Asserts that the contents of this list pass the specified tests.
R	isHas(E... entries)	Asserts that the contents of this list contain the specified values.
FluentListAssertion<E,R>	setMsg(String msg, Object... args)	Allows you to override the assertion failure message.
FluentListAssertion<E,R>	setOut(PrintStream value)	If an error occurs, send the error message to the specified stream instead of STDERR.
FluentListAssertion<E,R>	setSilent()	Suppresses output to STDERR.
FluentListAssertion<E,R>	setStdOut()	If an error occurs, send the error message to STDOUT instead of STDERR.
FluentListAssertion<E,R>	setThrowable(Class<? extends RuntimeException> value)	If an error occurs, throw this exception instead of the standard AssertionError.
protected List<E>	value()	Returns the inner value after asserting it is not null.

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

FluentListAssertion

public FluentListAssertion(List<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.

FluentListAssertion

public FluentListAssertion(Assertion creator,
 List<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

asApplied2

public FluentListAssertion<E,R> asApplied2(Function<List<E>,List<E>> function)

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

Parameters:

function - The transform to apply.

Returns:

A new assertion.

asItem

public FluentAnyAssertion<E,R> asItem(int index)

Returns an object assertion on the item specified at the specified index.

If the list is null or the index is out-of-bounds, the returned assertion is a null assertion (meaning FluentObjectAssertion.isExists() returns false).

Parameters:

index - The index of the item to retrieve from the list.

Returns:

A new assertion.

asSorted

public FluentListAssertion<E,R> asSorted()

Sorts the entries in this list.

Returns:

A new list assertion. The contents of the original list remain unchanged.

asSorted

public FluentListAssertion<E,R> asSorted(Comparator<E> comparator)

Sorts the entries in this list using the specified comparator.

Parameters:

comparator - The comparator to use to sort the list.

Returns:

A new list assertion. The contents of the original list remain unchanged.

asFirst

public FluentAnyAssertion<E,R> asFirst()

Returns the first entry from this list.

Returns:

A new list assertion.

asLast

public FluentAnyAssertion<E,R> asLast()

Returns the last entry from this list.

Returns:

A new list assertion.

asFirst

public FluentListAssertion<E,R> asFirst(int count)

Returns the first X number of entries from this list.

Parameters:

count - The number of entries in the list to retrieve.

Returns:

A new list assertion. The contents of the original list remain unchanged.

asLast

public FluentListAssertion<E,R> asLast(int count)

Returns the first X number of entries from this list.

Parameters:

count - The number of entries in the list to retrieve.

Returns:

A new list assertion. The contents of the original list remain unchanged.

asSublist

public FluentListAssertion<E,R> asSublist(int start,
 int end)

Returns a sublist of the entries in this list.

Parameters:

start - The start index (inclusive).

end - The end index (exclusive).

Returns:

A new list assertion. The contents of the original list remain unchanged.

asStrings

public FluentStringListAssertion<R> asStrings(Function<E,String> function)

Runs the stringify function against all values in this list and returns it as a fluent string list assertion.

Parameters:

function - The function to apply to all values in this list.

Returns:

A new fluent string list assertion. Never null.

asCdl

public FluentStringAssertion<R> asCdl()

Converts the entries in this list to a simple comma-delimited list and returns the value as a fluent string assertion.

Returns:

A fluent string assertion. Never null.

asCdl

public FluentStringAssertion<R> asCdl(Function<E,String> function)

Converts the entries to strings using the specified stringify function, combines them into a simple comma-delimited list, and returns the value as a fluent string assertion.

Parameters:

function - The function to apply to all values in this list.

Returns:

A fluent string assertion. Never null.

isHas

public R isHas(E... entries)
        throws AssertionError

Asserts that the contents of this list contain the specified values.

Parameters:

entries - The expected entries in this list.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed.

isEach

@SafeVarargs
public final R isEach(Predicate<E>... tests)
               throws AssertionError

Asserts that the contents of this list pass the specified tests.

Parameters:

tests - The tests to run. null predicates are ignored.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed.

setMsg

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

Parameters:

msg - The assertion failure message.

args - Optional message arguments.

Returns:

This object.

setOut

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

Parameters:

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

Returns:

This object.

setSilent

public FluentListAssertion<E,R> setSilent()

Description copied from class: Assertion

Suppresses output to STDERR.

This is the equivalent to calling out(null).

Overrides:

setSilent in class FluentCollectionAssertion<E,R>

Returns:

This object.

setStdOut

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

Returns:

This object.

setThrowable

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

Parameters:

value - The new value for this setting.

Returns:

This object.

value

protected List<E> value()
                 throws AssertionError

Description copied from class: FluentObjectAssertion

Returns the inner value after asserting it is not null.

Overrides:

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

Returns:

The inner value.

Throws:

AssertionError - If inner value was null.