Package org.apache.juneau.assertions

Class FluentMapAssertion<K,V,R>

java.lang.Object

org.apache.juneau.assertions.Assertion

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

org.apache.juneau.assertions.FluentObjectAssertion<Map<K,V>,R>

org.apache.juneau.assertions.FluentMapAssertion<K,V,R>

Type Parameters:

K - The key type.

V - The value type.

R - The return type.

Direct Known Subclasses:

MapAssertion

public class FluentMapAssertion<K,V,R>
extends FluentObjectAssertion<Map<K,V>,R>

Used for fluent assertion calls against maps.

Test Methods:

• FluentMapAssertion
  • isEmpty()
  • isNotEmpty()
  • isContainsKey(String)
  • isNotContainsKey(String)
  • isSize(int)
• 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:

• FluentMapAssertion
  • asValue(Object)
  • asValues(Object...)
  • asValueMap(Object...)
  • 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
FluentMapAssertion(Map<K,V> value, R returns)	Constructor.
FluentMapAssertion(Assertion creator, Map<K,V> value, R returns)	Chained constructor.

Method Summary

Modifier and Type	Method	Description
FluentIntegerAssertion<R>	asSize()	Returns an integer assertion on the size of this map.
FluentMapAssertion<K,V,R>	asTransformed(Function<Map<K,V>,Map<K,V>> function)	Applies a transform on the inner object and returns a new inner object.
FluentAnyAssertion<V,R>	asValue(K key)	Returns an object assertion on the value specified at the specified key.
FluentMapAssertion<K,V,R>	asValueMap(K... keys)	Extracts a subset of this map.
FluentListAssertion<Object,R>	asValues(K... keys)	Returns a FluentListAssertion of the values of the specified keys.
R	isContainsKey(String name)	Asserts that the map contains the expected key.
R	isEmpty()	Asserts that the map exists and is empty.
R	isNotContainsKey(String name)	Asserts that the map contains the expected key.
R	isNotEmpty()	Asserts that the map exists and is not empty.
R	isSize(int size)	Asserts that the map exists and is the specified size.
FluentMapAssertion<K,V,R>	setMsg(String msg, Object... args)	Allows you to override the assertion failure message.
FluentMapAssertion<K,V,R>	setOut(PrintStream value)	If an error occurs, send the error message to the specified stream instead of STDERR.
FluentMapAssertion<K,V,R>	setSilent()	Suppresses output to STDERR.
FluentMapAssertion<K,V,R>	setStdOut()	If an error occurs, send the error message to STDOUT instead of STDERR.
FluentMapAssertion<K,V,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

FluentMapAssertion

public FluentMapAssertion(Map<K,V> 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.

FluentMapAssertion

public FluentMapAssertion(Assertion creator,
 Map<K,V> 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 FluentMapAssertion<K,V,R> asTransformed(Function<Map<K,V>,Map<K,V>> function)

Description copied from class: FluentObjectAssertion

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

Overrides:

asTransformed in class FluentObjectAssertion<Map<K,V>,R>

Parameters:

function - The function to apply.

Returns:

This object.

asValue

public FluentAnyAssertion<V,R> asValue(K key)

Returns an object assertion on the value specified at the specified key.

If the map is null or the map doesn't contain the specified key, the returned assertion is a null assertion (meaning FluentObjectAssertion.isExists() returns false).

Parameters:

key - The key of the item to retrieve from the map.

Returns:

A new assertion.

asValues

public FluentListAssertion<Object,R> asValues(K... keys)

Returns a FluentListAssertion of the values of the specified keys. If the map is null, the returned assertion is a null assertion (meaning FluentObjectAssertion.isExists() returns false).

Parameters:

keys - The keys of the values to retrieve from the map.

Returns:

A new assertion.

asValueMap

public FluentMapAssertion<K,V,R> asValueMap(K... keys)

Extracts a subset of this map.

Parameters:

keys - The entries to extract.

Returns:

This object.

asSize

public FluentIntegerAssertion<R> asSize()

Returns an integer assertion on the size of this map.

If the map 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 map 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 map exists and is not empty.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed or value was null.

isContainsKey

public R isContainsKey(String name)
                throws AssertionError

Asserts that the map contains the expected key.

Parameters:

name - The key name to check for.

Returns:

The fluent return object.

Throws:

AssertionError - If assertion failed or value was null.

isNotContainsKey

public R isNotContainsKey(String name)
                   throws AssertionError

Asserts that the map contains the expected key.

Parameters:

name - The key name to check for.

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 map 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 FluentMapAssertion<K,V,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<Map<K,V>,R>

Parameters:

msg - The assertion failure message.

args - Optional message arguments.

Returns:

This object.

setOut

public FluentMapAssertion<K,V,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<Map<K,V>,R>

Parameters:

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

Returns:

This object.

setSilent

public FluentMapAssertion<K,V,R> setSilent()

Description copied from class: Assertion

Suppresses output to STDERR.

This is the equivalent to calling out(null).

Overrides:

setSilent in class FluentObjectAssertion<Map<K,V>,R>

Returns:

This object.

setStdOut

public FluentMapAssertion<K,V,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<Map<K,V>,R>

Returns:

This object.

setThrowable

public FluentMapAssertion<K,V,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<Map<K,V>,R>

Parameters:

value - The new value for this setting.

Returns:

This object.