edu.hm.hafner.util

Class Ensure.CollectionCondition

java.lang.Object

edu.hm.hafner.util.Ensure.ObjectCondition

edu.hm.hafner.util.Ensure.IterableCondition

edu.hm.hafner.util.Ensure.CollectionCondition

Enclosing class:

Ensure

public static class Ensure.CollectionCondition
extends Ensure.IterableCondition

Assertions for iterables.

Constructor Summary

Constructors

Constructor and Description
CollectionCondition(Collection<?> value) Creates a new instance of CollectionCondition.

Method Summary

Modifier and Type	Method and Description
void	contains(Object element) Ensures that the given collection is not null and contains the specified element.
void	contains(Object element, String explanation, Object... args) Ensures that the given collection is not null and contains the specified element.
void	doesNotContain(Object element) Ensures that the given collection is not null and does not contain the specified element.
void	doesNotContain(Object element, String explanation, Object... args) Ensures that the given collection is not null and does not contain the specified element.

Methods inherited from class edu.hm.hafner.util.Ensure.IterableCondition

isNotEmpty, isNotEmpty

Methods inherited from class edu.hm.hafner.util.Ensure.ObjectCondition

isInstanceOf, isInstanceOf, isNotNull, isNotNull, isNull, isNull

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionCondition

public CollectionCondition(@CheckForNull
                           Collection<?> value)

Creates a new instance of CollectionCondition.

Parameters:

value - value of the condition

Method Detail

contains

public void contains(Object element)

Ensures that the given collection is not null and contains the specified element.

Parameters:

element - the element to find

Throws:

AssertionError - if the collection is null or if the specified element is not found

contains

@FormatMethod
public void contains(Object element,
                                   String explanation,
                                   Object... args)

Ensures that the given collection is not null and contains the specified element.

Parameters:

element - the element to find

explanation - a formatted message explaining the assertion

args - Arguments referenced by the format specifiers in the formatted explanation. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero.

Throws:

AssertionError - if the collection is null or if the specified element is not found

doesNotContain

public void doesNotContain(Object element)

Ensures that the given collection is not null and does not contain the specified element.

Parameters:

element - the element that must not be in the collection

Throws:

AssertionError - if the collection is null or if the specified element is part of the collection

doesNotContain

@FormatMethod
public void doesNotContain(Object element,
                                         String explanation,
                                         Object... args)

Ensures that the given collection is not null and does not contain the specified element.

Parameters:

element - the element that must not be in the collection

explanation - a formatted message explaining the assertion

args - Arguments referenced by the format specifiers in the formatted explanation. If there are more arguments than format specifiers, the extra arguments are ignored. The number of arguments is variable and may be zero.

Throws:

AssertionError - if the collection is null or if the specified element is part of the collection