Package org.apache.juneau.assertions

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

Type Parameters:

E - The array element type.

T - The array type.

R - The return type.

Direct Known Subclasses:

FluentByteArrayAssertion, PrimitiveArrayAssertion

public class FluentPrimitiveArrayAssertion<E,T,R>
extends FluentObjectAssertion<T,R>

Used for fluent assertion calls against primitive array objects (e.g. int[]).

Test Methods:

• FluentPrimitiveArrayAssertion
  • isHas(Object...)
  • is(Predicate)
  • isAny(Predicate)
  • isAll(Predicate)
  • isEmpty()
  • isNotEmpty()
  • isSize(int)
  • isContains(Object)
  • isNotContains(Object)
• 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:

• FluentPrimitiveArrayAssertion
  • asItem(int)
  • asLength()
• 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
FluentPrimitiveArrayAssertion(Assertion creator, T value, R returns)	Chained constructor.
FluentPrimitiveArrayAssertion(T value, R returns)	Constructor.

Method Summary

Modifier and Type	Method	Description
FluentAnyAssertion<E,R>	asItem(int index)	Returns an object assertion on the item specified at the specified index.
FluentIntegerAssertion<R>	asLength()	Returns an integer assertion on the length of this array.
FluentStringAssertion<R>	asString()	Converts this object to a string using Object.toString() and returns it as a new assertion.
FluentPrimitiveArrayAssertion<E,T,R>	asTransformed(Function<T,T> function)	Applies a transform on the inner object and returns a new inner object.
final R	is(Predicate<E>... tests)	Asserts that the contents of this list pass the specified tests.
R	isAll(Predicate<E> test)	Asserts that all values in the array pass the specified test.
R	isAny(Predicate<E> test)	Asserts that at least one value in the array passes the specified test.
R	isContains(E entry)	Asserts that the array contains the expected entry.
R	isEmpty()	Asserts that the collection exists and is empty.
R	isHas(E... entries)	Asserts that the contents of this list contain the specified values.
R	isNotContains(E entry)	Asserts that the array does not contain 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.
FluentPrimitiveArrayAssertion<E,T,R>	setMsg(String msg, Object... args)	Allows you to override the assertion failure message.
FluentPrimitiveArrayAssertion<E,T,R>	setOut(PrintStream value)	If an error occurs, send the error message to the specified stream instead of STDERR.
FluentPrimitiveArrayAssertion<E,T,R>	setSilent()	Suppresses output to STDERR.
FluentPrimitiveArrayAssertion<E,T,R>	setStdOut()	If an error occurs, send the error message to STDOUT instead of STDERR.
FluentPrimitiveArrayAssertion<E,T,R>	setThrowable(Class<? extends RuntimeException> value)	If an error occurs, throw this exception instead of the standard AssertionError.
String	toString()	Returns the string form of the inner object.

Methods inherited from class org.apache.juneau.assertions.FluentObjectAssertion

asAny, asJson, asJsonSorted, asString, asString, asTransformedTo, equals, getFailureMessage, is, is, isAny, isExactType, isExists, isJson, isNot, isNotAny, isNotNull, isNull, isSame, isSameJsonAs, isSameSerializedAs, isSameSortedJsonAs, isString, isType, map, opt, orElse, 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

FluentPrimitiveArrayAssertion

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

FluentPrimitiveArrayAssertion

public FluentPrimitiveArrayAssertion(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 FluentPrimitiveArrayAssertion<E,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.

asString

public FluentStringAssertion<R> asString()

Description copied from class: FluentObjectAssertion

Converts this object to a string using Object.toString() and returns it as a new assertion.

Example:

// Validates that the specified object is "foobar" after converting to a string. assertObject(myPojo) .asString() .is("foobar");

Overrides:

asString in class FluentObjectAssertion<T,R>

Returns:

A new fluent string assertion.

asItem

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

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

If the array 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 array.

Returns:

A new assertion.

asLength

public FluentIntegerAssertion<R> asLength()

Returns an integer assertion on the length of this array.

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

Returns:

A new assertion.

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:

This object.

Throws:

AssertionError - If assertion failed.

is

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

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

Parameters:

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

Returns:

This object.

Throws:

AssertionError - If assertion failed.

isAny

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

Asserts that at least one value in the array 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 array pass the specified test.

Parameters:

test - The predicate test.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed or value was null.

isEmpty

public R isEmpty()
          throws AssertionError

Asserts that the collection exists and is empty.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed.

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.

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.

isContains

public R isContains(E entry)
             throws AssertionError

Asserts that the array contains the expected entry.

Parameters:

entry - The value to check for.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed.

isNotContains

public R isNotContains(E entry)
                throws AssertionError

Asserts that the array does not contain the expected value.

Parameters:

entry - The value to check for.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed.

setMsg

public FluentPrimitiveArrayAssertion<E,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 FluentPrimitiveArrayAssertion<E,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 FluentPrimitiveArrayAssertion<E,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 FluentPrimitiveArrayAssertion<E,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 FluentPrimitiveArrayAssertion<E,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.

toString

public String toString()

Description copied from class: FluentObjectAssertion

Returns the string form of the inner object. Subclasses can override this method to affect the FluentObjectAssertion.asString() method (and related).

Overrides:

toString in class FluentObjectAssertion<T,R>