de.team33.patterns.collection.ceres

Interface Collecting.Setup<E,C extends Collection<E>,S extends Collecting.Setup<E,C,S>>

Type Parameters:

E - The element type.

C - The final type of the target instance, at least Collection.

S - The final type of the Setup implementation.

All Superinterfaces:

Setup<C,S>

All Known Implementing Classes:

Collecting.Builder, Collecting.Charger

Enclosing class:

Collecting

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public static interface Collecting.Setup<E,C extends Collection<E>,S extends Collecting.Setup<E,C,S>>
extends Setup<C,S>

Utility interface to set up a target instance of Collection.

Method Summary

Modifier and Type	Method and Description
default S	add(E element) Adds an element to the instance to be set up.
default S	add(E element0, E element1, E... more) Adds two or more elements to the instance to be set up.
default S	addAll(Collection<? extends E> elements) Adds multiple elements to the instance to be set up.
default S	addAll(E[] elements) Adds multiple elements to the instance to be set up.
default S	addAll(Iterable<? extends E> elements) Adds multiple elements to the instance to be set up.
default S	addAll(Iterator<? extends E> elements) Adds multiple elements to the instance to be set up.
default S	addAll(Stream<? extends E> elements) Adds multiple elements to the instance to be set up.
default S	clear() Removes all elements from the instance to be set up.
default S	remove(Object element) Removes an element from the instance to be set up.
default S	remove(Object element0, Object element1, Object... more) Removes two or more elements from the instance to be set up.
default S	removeAll(Collection<?> elements) Removes multiple elements from the instance to be set up.
default S	removeAll(Iterable<?> elements) Removes multiple elements from the instance to be set up.
default S	removeAll(Iterator<?> elements) Removes multiple elements from the instance to be set up.
default S	removeAll(Object[] elements) Removes multiple elements from the instance to be set up.
default S	removeAll(Stream<?> elements) Removes multiple elements from the instance to be set up.
default S	removeIf(Predicate<? super E> filter) Removes multiple elements from the instance to be set up.
default S	retainAll(Collection<?> elements) Retains multiple elements by removing all others from the instance to be set up.
default S	retainAll(Iterable<?> elements) Retains multiple elements by removing all others from the instance to be set up.
default S	retainAll(Iterator<?> elements) Retains multiple elements by removing all others from the instance to be set up.
default S	retainAll(Object[] elements) Retains multiple elements by removing all others from the instance to be set up.
default S	retainAll(Stream<?> elements) Retains multiple elements by removing all others from the instance to be set up.

Methods inherited from interface de.team33.patterns.building.elara.Setup

setup

Method Detail

add

default S add(E element)

Adds an element to the instance to be set up.

Throws:

UnsupportedOperationException - if Collection.add(Object) is not supported by the instance to be set up.

NullPointerException - if the specified element is null and the instance to be set up does not permit null elements.

ClassCastException - if the class of the specified element prevents it from being added to the instance to be set up (may occur only if used raw or forced in a mismatched class context).

IllegalArgumentException - if some property of the element prevents it from being added to the instance to be set up.

IllegalStateException - if the element cannot be added at this time due to insertion restrictions on the instance to be set up (if any).

See Also:

Collection.add(Object), Collecting.add(Collection, Object)

add

default S add(E element0,
              E element1,
              E... more)

Adds two or more elements to the instance to be set up.

If the array of more elements is null it will be treated as an empty array.

Throws:

UnsupportedOperationException - if Collection.add(Object) is not supported by the instance to be set up.

NullPointerException - if any of the specified elements is null and the instance to be set up does not permit null elements.

ClassCastException - if the class of any specified elements prevents them from being added to the instance to be set up (may occur only if used raw or forced in a mismatched class context).

IllegalArgumentException - if some property of any elements prevents them from being added to the instance to be set up.

IllegalStateException - if any of the elements cannot be added at this time due to insertion restrictions of the instance to be set up (if any).

See Also:

add(Object), Collecting.add(Collection, Object, Object, Object[])

addAll

default S addAll(Collection<? extends E> elements)

Adds multiple elements to the instance to be set up.

If the Collection of elements is null it will be treated as an empty Collection.

Throws:

UnsupportedOperationException - if Collection.addAll(Collection) is not supported by the instance to be set up.

NullPointerException - if any of the specified elements is null and the instance to be set up does not permit null elements.

ClassCastException - if the class of any specified elements prevents them from being added to the instance to be set up (may occur only if used raw or forced in a mismatched class context).

IllegalArgumentException - if some property of any elements prevents them from being added to the instance to be set up.

IllegalStateException - if any of the elements cannot be added at this time due to insertion restrictions of the instance to be set up (if any).

See Also:

Collection.addAll(Collection), Collecting.addAll(Collection, Collection), addAll(Stream), addAll(Iterable), addAll(Iterator), addAll(Object[])

addAll

default S addAll(Stream<? extends E> elements)

Adds multiple elements to the instance to be set up.

If the Stream of elements is null it will be treated as an empty Stream.

Throws:

UnsupportedOperationException - if Collection.add(Object) is not supported by the instance to be set up.

NullPointerException - if any of the specified elements is null and the instance to be set up does not permit null elements.

ClassCastException - if the class of any specified elements prevents them from being added to the instance to be set up (may occur only if used raw or forced in a mismatched class context).

IllegalArgumentException - if some property of any elements prevents them from being added to the instance to be set up.

IllegalStateException - if any of the elements cannot be added at this time due to insertion restrictions of the instance to be set up (if any).

See Also:

Collecting.addAll(Collection, Stream), addAll(Collection), addAll(Iterable), addAll(Iterator), addAll(Object[])

addAll

default S addAll(Iterable<? extends E> elements)

Adds multiple elements to the instance to be set up.

Treats a null-argument just like an empty Iterable.

Throws:

UnsupportedOperationException - if Collection.add(Object) or if Collection.addAll(Collection) is not supported by the instance to be set up.

NullPointerException - if any of the specified elements is null and the instance to be set up does not permit null elements.

ClassCastException - if the class of any specified elements prevents them from being added to the instance to be set up (may occur only if used raw or forced in a mismatched class context).

IllegalArgumentException - if some property of any elements prevents them from being added to the instance to be set up.

IllegalStateException - if any of the elements cannot be added at this time due to insertion restrictions of the instance to be set up (if any).

See Also:

Collecting.addAll(Collection, Iterable), addAll(Collection), addAll(Stream), addAll(Iterator), addAll(Object[])

addAll

default S addAll(Iterator<? extends E> elements)

Adds multiple elements to the instance to be set up.

Treats a null-argument just like an empty Iterator.

Throws:

UnsupportedOperationException - if Collection.add(Object) or if Collection.addAll(Collection) is not supported by the instance to be set up.

NullPointerException - if any of the specified elements is null and the instance to be set up does not permit null elements.

ClassCastException - if the class of any specified elements prevents them from being added to the instance to be set up (may occur only if used raw or forced in a mismatched class context).

IllegalArgumentException - if some property of any elements prevents them from being added to the instance to be set up.

IllegalStateException - if any of the elements cannot be added at this time due to insertion restrictions of the instance to be set up (if any).

See Also:

Collecting.addAll(Collection, Iterable), addAll(Collection), addAll(Stream), addAll(Iterable), addAll(Object[])

addAll

default S addAll(E[] elements)

Adds multiple elements to the instance to be set up.

Treats a null-argument just like an empty array.

Throws:

UnsupportedOperationException - if Collection.add(Object) or if Collection.addAll(Collection) is not supported by the instance to be set up.

NullPointerException - if any of the specified elements is null and the instance to be set up does not permit null elements.

ClassCastException - if the class of any specified elements prevents them from being added to the instance to be set up (may occur only if used raw or forced in a mismatched class context).

IllegalArgumentException - if some property of any elements prevents them from being added to the instance to be set up.

IllegalStateException - if any of the elements cannot be added at this time due to insertion restrictions of the instance to be set up (if any).

See Also:

Collecting.addAll(Collection, Iterable), addAll(Collection), addAll(Stream), addAll(Iterable), addAll(Iterator)

remove

default S remove(Object element)

Removes an element from the instance to be set up.

If the instance to be set up contains the element several times, each occurrence will be removed!

Avoids an unnecessary ClassCastException or NullPointerException which might be caused by Collection.remove(Object) or Collection.removeAll(Collection) when the instance to be set up does not support the requested element.

Throws:

UnsupportedOperationException - if Collection.remove(Object) or if Collection.removeAll(Collection) is not supported by the instance to be set up.

See Also:

Collection.remove(Object), Collecting.remove(Collection, Object)

remove

default S remove(Object element0,
                 Object element1,
                 Object... more)

Removes two or more elements from the instance to be set up.

If the instance to be set up contains an element several times, each occurrence will be removed!

Throws:

UnsupportedOperationException - if Collection.remove(Object) or if Collection.removeAll(Collection) is not supported by the instance to be set up.

See Also:

remove(Object), Collecting.remove(Collection, Object, Object, Object[])

removeAll

default S removeAll(Collection<?> elements)

Removes multiple elements from the instance to be set up.

If the instance to be set up contains an element several times, each occurrence will be removed!

Treats a null-argument just like an empty Collection.

Avoids an unnecessary ClassCastException or NullPointerException which might be caused by Collection.remove(Object) or Collection.removeAll(Collection) when the instance to be set up does not support the requested elements.

Throws:

UnsupportedOperationException - if Collection.remove(Object) or if Collection.removeAll(Collection) is not supported by the instance to be set up.

See Also:

Collection.removeAll(Collection), Collecting.removeAll(Collection, Collection), removeAll(Stream), removeAll(Iterable), removeAll(Iterator), removeAll(Object[])

removeAll

default S removeAll(Stream<?> elements)

Removes multiple elements from the instance to be set up.

If the instance to be set up contains an element several times, each occurrence will be removed!

Treats a null-argument just like an empty Stream.

Throws:

UnsupportedOperationException - if Collection.remove(Object) or if Collection.removeAll(Collection) is not supported by the instance to be set up.

See Also:

Collecting.removeAll(Collection, Stream), removeAll(Collection), removeAll(Iterable), removeAll(Iterator), removeAll(Object[])

removeAll

default S removeAll(Iterable<?> elements)

Removes multiple elements from the instance to be set up.

If the instance to be set up contains an element several times, each occurrence will be removed!

Treats a null-argument just like an empty Iterable.

Throws:

UnsupportedOperationException - if Collection.remove(Object) or if Collection.removeAll(Collection) is not supported by the instance to be set up.

See Also:

Collecting.removeAll(Collection, Iterable), removeAll(Collection), removeAll(Stream), removeAll(Iterator), removeAll(Object[])

removeAll

default S removeAll(Iterator<?> elements)

Removes multiple elements from the instance to be set up.

If the instance to be set up contains an element several times, each occurrence will be removed!

Treats a null-argument just like an empty Iterator.

Throws:

UnsupportedOperationException - if Collection.remove(Object) or if Collection.removeAll(Collection) is not supported by the instance to be set up.

See Also:

Collecting.removeAll(Collection, Iterable), removeAll(Collection), removeAll(Stream), removeAll(Iterable), removeAll(Object[])

removeAll

default S removeAll(Object[] elements)

Removes multiple elements from the instance to be set up.

If the instance to be set up contains an element several times, each occurrence will be removed!

Treats a null-argument just like an empty array.

Throws:

UnsupportedOperationException - if Collection.remove(Object) or if Collection.removeAll(Collection) is not supported by the instance to be set up.

See Also:

Collecting.removeAll(Collection, Object[]), removeAll(Collection), removeAll(Stream), removeAll(Iterable), removeAll(Iterator)

removeIf

default S removeIf(Predicate<? super E> filter)

Removes multiple elements from the instance to be set up.

Throws:

UnsupportedOperationException - if Collection.removeIf(Predicate) is not supported by the instance to be set up.

NullPointerException - if the filter is null.

See Also:

Collection.removeIf(Predicate), Collecting.removeIf(Collection, Predicate)

retainAll

default S retainAll(Collection<?> elements)

Retains multiple elements by removing all others from the instance to be set up.

Treats a null-argument just like an empty Collection.

Avoids an unnecessary ClassCastException or NullPointerException which might be caused by Collection.retainAll(Collection) when the instance to be set up does not support the requested elements.

Throws:

UnsupportedOperationException - if Collection.retainAll(Collection) is not supported by the instance to be set up.

See Also:

Collection.retainAll(Collection), Collecting.retainAll(Collection, Collection), retainAll(Stream), retainAll(Iterable), retainAll(Iterator), retainAll(Object[])

retainAll

default S retainAll(Stream<?> elements)

Retains multiple elements by removing all others from the instance to be set up.

Treats a null-argument just like an empty Stream.

Throws:

UnsupportedOperationException - if Collection.retainAll(Collection) is not supported by the instance to be set up.

See Also:

Collecting.retainAll(Collection, Stream), retainAll(Collection), retainAll(Iterable), retainAll(Iterator), retainAll(Object[])

retainAll

default S retainAll(Iterable<?> elements)

Retains multiple elements by removing all others from the instance to be set up.

Treats a null-argument just like an empty Iterable.

Throws:

UnsupportedOperationException - if Collection.retainAll(Collection) is not supported by the instance to be set up.

See Also:

Collecting.retainAll(Collection, Iterable), retainAll(Collection), retainAll(Stream), retainAll(Iterator), retainAll(Object[])

retainAll

default S retainAll(Iterator<?> elements)

Retains multiple elements by removing all others from the instance to be set up.

Treats a null-argument just like an empty Iterator.

Throws:

UnsupportedOperationException - if Collection.retainAll(Collection) is not supported by the instance to be set up.

See Also:

Collecting.retainAll(Collection, Iterable), retainAll(Collection), retainAll(Stream), retainAll(Iterable), retainAll(Object[])

retainAll

default S retainAll(Object[] elements)

Retains multiple elements by removing all others from the instance to be set up.

Treats a null-argument just like an empty array.

Throws:

UnsupportedOperationException - if Collection.retainAll(Collection) is not supported by the instance to be set up.

See Also:

Collecting.retainAll(Collection, Object[]), retainAll(Collection), retainAll(Stream), retainAll(Iterable), retainAll(Iterator)

clear

default S clear()

Removes all elements from the instance to be set up.

Throws:

UnsupportedOperationException - if Collection.clear() is not supported by the instance to be set up.

See Also:

Collection.clear(), Collecting.clear(Collection)