Module com.github.cowwoc.requirements10.java

Package com.github.cowwoc.requirements10.java.validator

Interface MapValidator<T extends Map<K,V>,K,V>

Type Parameters:

T - the type of the map

K - the type of keys in the map

V - the type of values in the map

All Superinterfaces:

ObjectComponent<MapValidator<T,K,V>,T>, ValidatorComponent<MapValidator<T,K,V>,T>

public interface MapValidator<T extends Map<K,V>,K,V>
extends ValidatorComponent<MapValidator<T,K,V>,T>, ObjectComponent<MapValidator<T,K,V>,T>

Validates the state of a Map.

Method Summary

Modifier and Type	Method	Description
CollectionValidator<Set<Map.Entry<K,V>>,Map.Entry<K,V>>	entrySet()	Returns a validator for the value's entries.
MapValidator<T,K,V>	isEmpty()	Ensures that the value is empty.
MapValidator<T,K,V>	isNotEmpty()	Ensures that the value is not empty.
CollectionValidator<Set<K>,K>	keySet()	Returns a validator for the value's keys.
PrimitiveUnsignedIntegerValidator	size()	Returns a validator for the map's size.
CollectionValidator<Collection<V>,V>	values()	Returns a validator for the value's values.

Methods declared in interface com.github.cowwoc.requirements10.java.validator.component.ObjectComponent

getValue, isEqualTo, isEqualTo, isInstanceOf, isInstanceOf, isNotEqualTo, isNotEqualTo, isNotInstanceOf, isNotInstanceOf, isNotNull, isNull, isReferenceEqualTo, isReferenceNotEqualTo

Methods declared in interface com.github.cowwoc.requirements10.java.validator.component.ValidatorComponent

and, elseGetFailures, elseThrow, getContext, getContextAsString, getName, getValueOrDefault, validationFailed, withContext

Method Details

keySet

CollectionValidator<Set<K>,K> keySet()

Returns a validator for the value's keys.

Returns:

a validator for the value's keys

Throws:

NullPointerException - if the value is null

values

CollectionValidator<Collection<V>,V> values()

Returns a validator for the value's values.

Returns:

a validator for the value's values

Throws:

NullPointerException - if the value is null

entrySet

CollectionValidator<Set<Map.Entry<K,V>>,Map.Entry<K,V>> entrySet()

Returns a validator for the value's entries.

Returns:

a validator for the value's entries

Throws:

NullPointerException - if the value is null

isEmpty

MapValidator<T,K,V> isEmpty()

Ensures that the value is empty.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if value is not empty

isNotEmpty

MapValidator<T,K,V> isNotEmpty()

Ensures that the value is not empty.

Returns:

this

Throws:

NullPointerException - if the value is null

IllegalArgumentException - if value is empty

size

PrimitiveUnsignedIntegerValidator size()

Returns a validator for the map's size.

Returns:

a validator for the map's size

Throws:

NullPointerException - if the value is null