org.bitbucket.cowwoc.requirements.spi

Interface CollectionRequirementsSpi<S extends CollectionRequirementsSpi<S,E>,E>

Type Parameters:

S - the type of the non-SPI interface extending this interface

E - the type of element in the collection

All Superinterfaces:

ObjectRequirementsSpi<S,Collection<E>>

All Known Subinterfaces:

CollectionRequirements<E>

public interface CollectionRequirementsSpi<S extends CollectionRequirementsSpi<S,E>,E>
extends ObjectRequirementsSpi<S,Collection<E>>

Verifies requirements of a Collection parameter.

Author:

Gili Tzabari

Method Summary

Modifier and Type	Method and Description
S	contains(E element) Ensures that the parameter contains an element.
S	contains(E element, String name) Ensures that the parameter contains an element.
S	containsAll(Collection<E> elements) Ensures that the parameter contains all of multiple elements.
S	containsAll(Collection<E> elements, String name) Ensures that the parameter contains all of multiple elements.
S	containsAny(Collection<E> elements) Ensures that the parameter contains any of multiple elements.
S	containsAny(Collection<E> elements, String name) Ensures that the parameter contains any of multiple elements.
S	containsExactly(Collection<E> elements) Ensures that the parameter contains exactly the specified elements; nothing less, nothing more.
S	containsExactly(Collection<E> elements, String name) Ensures that the parameter contains exactly the specified elements; nothing less, nothing more.
S	doesNotContain(E element) Ensures that the parameter does not contain an element.
S	doesNotContain(E element, String name) Ensures that the parameter does not contain an element.
S	doesNotContainAll(Collection<E> elements) Ensures that the parameter does not contain all of multiple elements.
S	doesNotContainAll(Collection<E> elements, String name) Ensures that the parameter does not contain all of multiple elements.
S	doesNotContainAny(Collection<E> elements) Ensures that the parameter does not contain any of multiple elements.
S	doesNotContainAny(Collection<E> elements, String name) Ensures that the parameter does not contain any of multiple elements.
S	doesNotContainDuplicates() Ensures that the parameter does not contain any duplicate elements.
S	isEmpty() Ensures that the parameter is empty.
S	isNotEmpty() Ensures that the parameter is not empty.
CollectionSizeRequirements	size()

Methods inherited from interface org.bitbucket.cowwoc.requirements.spi.ObjectRequirementsSpi

isEqualTo, isEqualTo, isInstanceOf, isNotEqualTo, isNotEqualTo, isNotNull, isNull, withContext, withException

Method Detail

isEmpty

S isEmpty()
   throws IllegalArgumentException

Ensures that the parameter is empty.

Returns:

this

Throws:

IllegalArgumentException - if parameter is not empty

isNotEmpty

S isNotEmpty()
      throws IllegalArgumentException

Ensures that the parameter is not empty.

Returns:

this

Throws:

IllegalArgumentException - if parameter is empty

contains

S contains(E element)
    throws IllegalArgumentException

Ensures that the parameter contains an element.

Parameters:

element - the element that must exist

Returns:

this

Throws:

IllegalArgumentException - if the collection does not contain element

contains

S contains(E element,
           String name)
    throws NullPointerException,
           IllegalArgumentException

Ensures that the parameter contains an element.

Parameters:

element - the element that must exist

name - the name of the element

Returns:

this

Throws:

NullPointerException - if name is null

IllegalArgumentException - if the collection does not contain element; if name is empty

containsExactly

S containsExactly(Collection<E> elements)
           throws NullPointerException,
                  IllegalArgumentException

Ensures that the parameter contains exactly the specified elements; nothing less, nothing more.

Parameters:

elements - the elements that must exist

Returns:

this

Throws:

NullPointerException - if elements is null

IllegalArgumentException - if the collection is missing any elements in elements; if the collection contains elements not found in elements

containsExactly

S containsExactly(Collection<E> elements,
                  String name)
           throws NullPointerException,
                  IllegalArgumentException

Ensures that the parameter contains exactly the specified elements; nothing less, nothing more.

Parameters:

elements - the elements that must exist

name - the name of the elements

Returns:

this

Throws:

NullPointerException - if elements or name are null

IllegalArgumentException - if the collection is missing any elements in elements; if the collection contains elements not found in elements; if name is empty

containsAny

S containsAny(Collection<E> elements)
       throws NullPointerException,
              IllegalArgumentException

Ensures that the parameter contains any of multiple elements.

Parameters:

elements - the elements that must exist

Returns:

this

Throws:

NullPointerException - if elements is null

IllegalArgumentException - if the collection does not contain any of elements

containsAny

S containsAny(Collection<E> elements,
              String name)
       throws NullPointerException,
              IllegalArgumentException

Ensures that the parameter contains any of multiple elements.

Parameters:

elements - the elements that must exist

name - the name of the elements

Returns:

this

Throws:

NullPointerException - if elements or name are null

IllegalArgumentException - if the collection does not contain any of elements; if name is empty

containsAll

S containsAll(Collection<E> elements)
       throws NullPointerException,
              IllegalArgumentException

Ensures that the parameter contains all of multiple elements.

Parameters:

elements - the elements that must exist

Returns:

this

Throws:

NullPointerException - if elements is null

IllegalArgumentException - if the collection does not contain all of elements

containsAll

S containsAll(Collection<E> elements,
              String name)
       throws NullPointerException,
              IllegalArgumentException

Ensures that the parameter contains all of multiple elements.

Parameters:

elements - the elements that must exist

name - the name of the elements

Returns:

this

Throws:

NullPointerException - if elements or name are null

IllegalArgumentException - if the collection does not contain all of elements; if name is empty

doesNotContain

S doesNotContain(E element)
          throws IllegalArgumentException

Ensures that the parameter does not contain an element.

Parameters:

element - the element that must not exist

Returns:

this

Throws:

IllegalArgumentException - if the collection contains element

doesNotContain

S doesNotContain(E element,
                 String name)
          throws NullPointerException,
                 IllegalArgumentException

Ensures that the parameter does not contain an element.

Parameters:

element - the element that must not exist

name - the name of the element

Returns:

this

Throws:

NullPointerException - if name is null

IllegalArgumentException - if the collection contains element; if name is empty

doesNotContainAny

S doesNotContainAny(Collection<E> elements)
             throws NullPointerException,
                    IllegalArgumentException

Ensures that the parameter does not contain any of multiple elements.

Parameters:

elements - the elements that must not exist

Returns:

this

Throws:

NullPointerException - if elements is null

IllegalArgumentException - if the collection contains any of elements

doesNotContainAny

S doesNotContainAny(Collection<E> elements,
                    String name)
             throws NullPointerException,
                    IllegalArgumentException

Ensures that the parameter does not contain any of multiple elements.

Parameters:

elements - the elements that must not exist

name - the name of the elements

Returns:

this

Throws:

NullPointerException - if elements or name are null

IllegalArgumentException - if the collection contains any of elements; if name is empty

doesNotContainAll

S doesNotContainAll(Collection<E> elements)
             throws NullPointerException,
                    IllegalArgumentException

Ensures that the parameter does not contain all of multiple elements.

Parameters:

elements - the elements that must not exist

Returns:

this

Throws:

NullPointerException - if elements is null

IllegalArgumentException - if the collection contains all of elements

doesNotContainAll

S doesNotContainAll(Collection<E> elements,
                    String name)
             throws NullPointerException,
                    IllegalArgumentException

Ensures that the parameter does not contain all of multiple elements.

Parameters:

elements - the elements that must not exist

name - the name of the elements

Returns:

this

Throws:

NullPointerException - if elements or name are null

IllegalArgumentException - if the collection contains all of elements; if name is empty

doesNotContainDuplicates

S doesNotContainDuplicates()
                    throws IllegalArgumentException

Ensures that the parameter does not contain any duplicate elements.

Returns:

this

Throws:

IllegalArgumentException - if the collection contains any duplicate elements

size

CollectionSizeRequirements size()

Returns:

requirements over Collection.size()