ch.trick17.betterchecks.fluent

Class CollectionCheck

java.lang.Object

ch.trick17.betterchecks.fluent.BaseCheck<C>

ch.trick17.betterchecks.fluent.ObjectBaseCheck<Collection<?>,CollectionCheck>

ch.trick17.betterchecks.fluent.CollectionCheck

@GwtCompatible
public final class CollectionCheck
extends ObjectBaseCheck<Collection<?>,CollectionCheck>

The check class for all Collection types. It provides a functionality similar to the ObjectArrayCheck class.

Most check methods are related to the size of the collection, like hasSize(int) or hasSizeBetween(int, int), but there is also the containsNoNull() method.

Author:

Michael Faes

Field Summary

Fields inherited from class ch.trick17.betterchecks.fluent.ObjectBaseCheck

arg, nullAllowed

Fields inherited from class ch.trick17.betterchecks.fluent.BaseCheck

argName, inverted

Constructor Summary

Constructors

Constructor and Description
CollectionCheck(Collection<?> arg) For internal use only.

Method Summary

Modifier and Type	Method and Description
CollectionCheck	containsNoNull() Checks that the collection argument does not contain any null element, throwing an exception otherwise.
CollectionCheck	hasSize(int size) Checks that the collection argument has the given size, throwing an exception otherwise.
CollectionCheck	hasSizeBetween(int min, int max) Checks that the collection argument's size is between the two given numbers, throwing an exception otherwise.
IntCheck	hasSizeWhich() Creates an IntCheck property check for the size of the collection argument.
CollectionCheck	isNotEmpty() Checks that the collection argument is not empty (meaning it has a size greater than zero), throwing an exception otherwise.

Methods inherited from class ch.trick17.betterchecks.fluent.ObjectBaseCheck

check, checkNull, checkWithCause, hasClass, intPropertyCheck, isEqualTo, isInstanceOf, isNotNull, isNullOr, isSameAs, objectPropertyCheck

Methods inherited from class ch.trick17.betterchecks.fluent.BaseCheck

checkConversion, me, named, not

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CollectionCheck

public CollectionCheck(Collection<?> arg)

For internal use only.

Method Detail

isNotEmpty

public CollectionCheck isNotEmpty()

Checks that the collection argument is not empty (meaning it has a size greater than zero), throwing an exception otherwise.

The message type used for exceptions thrown by this method is MessageType.ARG_EMPTY.

Returns:

This check

Throws:

IllegalArgumentException - if the collection argument is empty

See Also:

containsNoNull()

hasSize

public CollectionCheck hasSize(int size)

Checks that the collection argument has the given size, throwing an exception otherwise.

The message type used for exceptions thrown by this method is MessageType.ARG_SIZE.

To create more sophisticated checks using the collection size, use the hasSizeWhich() property check.

Parameters:

size - The size the collection should have

Returns:

This check

Throws:

IllegalArgumentException - if the collection argument has a size different from the given one

See Also:

hasSizeBetween(int, int)

hasSizeBetween

public CollectionCheck hasSizeBetween(int min,
                                      int max)

Checks that the collection argument's size is between the two given numbers, throwing an exception otherwise.

The message type used for exceptions thrown by this method is MessageType.ARG_SIZE_BETWEEN.

To create more sophisticated checks using the collection size, use the hasSizeWhich() property check.

Parameters:

min - The minimum size of the collection

max - The maximum size

Returns:

This check

Throws:

IllegalArgumentException - If the size of the collection is strictly less than min or strictly greater than max

hasSizeWhich

public IntCheck hasSizeWhich()

Creates an IntCheck property check for the size of the collection argument. It can be used to create advanced checks using the collection size. For example:

Check.that(list).isNullOr().hasSizeWhich().isGreaterThan(3);

Just like a check method, this method first asserts the non-nullness of the argument, throwing an exception in case of a failure.

The returned check has the size of this check's collection set as the argument and an argument name that indicates this fact. If the collection is null and allowed to be so (like in the above example), the returned property check is completely disabled, meaning none of its check methods will throw an exception. An inversion called before this method is ignored and does not have any effect on the check methods called on the returned property check.

Returns:

A property check for the size of the collection argument

containsNoNull

public CollectionCheck containsNoNull()

Checks that the collection argument does not contain any null element, throwing an exception otherwise. An empty collection is considered valid by this check.

The message type used for exceptions thrown by this method is MessageType.ARG_CONTAINS_NULL.

Returns:

This check

Throws:

IllegalArgumentException - If the collection contains one or more null elements