speiger.src.collections.booleans.collections

Interface BooleanCollection

All Superinterfaces:

BooleanIterable, java.util.Collection<java.lang.Boolean>, java.lang.Iterable<java.lang.Boolean>

All Known Subinterfaces:

BooleanList, BooleanSet

All Known Implementing Classes:

AbstractBooleanCollection, AbstractBooleanList, AbstractBooleanSet, BooleanArrayList, BooleanCollections.EmptyCollection, BooleanCollections.SynchronizedCollection, BooleanCollections.UnmodifiableCollection

public interface BooleanCollection
extends java.util.Collection<java.lang.Boolean>, BooleanIterable

A Type-Specific Collection that reduces (un)boxing

Method Summary

Modifier and Type	Method and Description
boolean	add(boolean o) A Type-Specific add function to reduce (un)boxing
default boolean	add(java.lang.Boolean o) Deprecated. Please use the corresponding type-specific function instead.
boolean	addAll(BooleanCollection c) A Type-Specific addAll function to reduce (un)boxing
boolean	contains(boolean o) A Type-Specific contains function to reduce (un)boxing
default boolean	contains(java.lang.Object o) Deprecated. Please use the corresponding type-specific function instead.
boolean	containsAll(BooleanCollection c) A Type-Specific containsAll function to reduce (un)boxing
boolean	containsAny(BooleanCollection c) A Type-Specific containsAny function to reduce (un)boxing
boolean	containsAny(java.util.Collection<?> c) Deprecated.
BooleanIterator	iterator() Returns a Type-Specific Iterator to reduce (un)boxing
boolean	remBoolean(boolean o) A Type-Specific remove function that reduces (un)boxing.
default boolean	remove(java.lang.Object o) Deprecated. Please use the corresponding type-specific function instead.
boolean	removeAll(BooleanCollection c) A Type-Specific removeAll function that reduces (un)boxing.
boolean	retainAll(BooleanCollection c) A Type-Specific retainAll function that reduces (un)boxing.
default BooleanSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
boolean[]	toBooleanArray() A Type-Specific toArray function that delegates to toBooleanArray(boolean[]) with a newly created array.
boolean[]	toBooleanArray(boolean[] a) A Type-Specific toArray function that reduces (un)boxing.

Methods inherited from interface java.util.Collection

addAll, clear, containsAll, equals, hashCode, isEmpty, parallelStream, removeAll, removeIf, retainAll, size, stream, toArray, toArray

Methods inherited from interface speiger.src.collections.booleans.collections.BooleanIterable

forEach, forEach

Method Detail

add

boolean add(boolean o)

A Type-Specific add function to reduce (un)boxing

Parameters:

o - the element that should be added

Returns:

true if the element was added to the collection

addAll

boolean addAll(BooleanCollection c)

A Type-Specific addAll function to reduce (un)boxing

Parameters:

c - the collection of elements that should be added

Returns:

true if elements were added into the collection

contains

boolean contains(boolean o)

A Type-Specific contains function to reduce (un)boxing

Parameters:

o - the element that is checked for

Returns:

true if the element is found in the collection

containsAll

boolean containsAll(BooleanCollection c)

A Type-Specific containsAll function to reduce (un)boxing

Parameters:

c - the collection of elements that should be tested for

Returns:

true if all the element is found in the collection

containsAny

boolean containsAny(BooleanCollection c)

A Type-Specific containsAny function to reduce (un)boxing

Parameters:

c - the collection of elements that should be tested for

Returns:

true if any element was found

containsAny

@Deprecated
boolean containsAny(java.util.Collection<?> c)

Deprecated.

Returns true if any element of the Collection is found in the provided collection. A Small Optimization function to find out of any element is present when comparing collections and not all of them.

Parameters:

c - the collection of elements that should be tested for

Returns:

true if any element was found.

remBoolean

boolean remBoolean(boolean o)

A Type-Specific remove function that reduces (un)boxing.

Parameters:

o - the element that should be removed

Returns:

true if the element was removed

See Also:

Collection.remove(Object)

removeAll

boolean removeAll(BooleanCollection c)

A Type-Specific removeAll function that reduces (un)boxing.

Parameters:

c - the collection of elements that should be removed

Returns:

true if any element was removed

See Also:

Collection.removeAll(Collection)

retainAll

boolean retainAll(BooleanCollection c)

A Type-Specific retainAll function that reduces (un)boxing.

Parameters:

c - the collection of elements that should be kept

Returns:

true if any element was removed

See Also:

Collection.retainAll(Collection)

toBooleanArray

boolean[] toBooleanArray()

A Type-Specific toArray function that delegates to toBooleanArray(boolean[]) with a newly created array.

Returns:

an array containing all of the elements in this collection

See Also:

Collection.toArray()

toBooleanArray

boolean[] toBooleanArray(boolean[] a)

A Type-Specific toArray function that reduces (un)boxing.

Parameters:

a - array that the elements should be injected to. If null or to small a new array with the right size is created

Returns:

an array containing all of the elements in this collection

See Also:

Collection.toArray(Object[])

add

@Deprecated
default boolean add(java.lang.Boolean o)

Deprecated. Please use the corresponding type-specific function instead.

This default implementation delegates to the corresponding type-specific function.

Specified by:

add in interface java.util.Collection<java.lang.Boolean>

contains

@Deprecated
default boolean contains(java.lang.Object o)

Deprecated. Please use the corresponding type-specific function instead.

This default implementation delegates to the corresponding type-specific function.

Specified by:

contains in interface java.util.Collection<java.lang.Boolean>

remove

@Deprecated
default boolean remove(java.lang.Object o)

Deprecated. Please use the corresponding type-specific function instead.

This default implementation delegates to the corresponding type-specific function.

Specified by:

remove in interface java.util.Collection<java.lang.Boolean>

iterator

BooleanIterator iterator()

Returns a Type-Specific Iterator to reduce (un)boxing

Specified by:

iterator in interface BooleanIterable

Specified by:

iterator in interface java.util.Collection<java.lang.Boolean>

Specified by:

iterator in interface java.lang.Iterable<java.lang.Boolean>

Returns:

a iterator of the collection

See Also:

Collection.iterator()

spliterator

default BooleanSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

spliterator in interface BooleanIterable

Specified by:

spliterator in interface java.util.Collection<java.lang.Boolean>

Specified by:

spliterator in interface java.lang.Iterable<java.lang.Boolean>

Returns:

type specific splititerator