BooleanCollection (Primitive-Collections 0.7.0 API)

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, BooleanLinkedList, CopyOnWriteBooleanArrayList, ImmutableBooleanList
```
public interface BooleanCollection
extends java.util.Collection<java.lang.Boolean>, BooleanIterable
```
A Type-Specific Collection that reduces (un)boxing

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
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.
`default boolean`	`addAll(boolean... e)` A Type-Specific Array based addAll method to reduce the amount of Wrapping
`default boolean`	`addAll(boolean[] e, int length)` A Type-Specific Array based addAll method to reduce the amount of Wrapping
`default boolean`	`addAll(boolean[] e, int offset, int length)` A Type-Specific Array based addAll method to reduce the amount of Wrapping
`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.
`BooleanCollection`	`copy()` A Function that does a shallow clone of the Collection itself.
`BooleanIterator`	`iterator()` Returns a Type-Specific Iterator to reduce (un)boxing
`default <E extends BooleanCollection> E`	`pour(E collection)` A Helper function to reduce the usage of Streams and allows to collect all elements
`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`	`removeAll(BooleanCollection c, BooleanConsumer r)` A Type-Specific removeAll function that reduces (un)boxing.
`boolean`	`retainAll(BooleanCollection c)` A Type-Specific retainAll function that reduces (un)boxing.
`boolean`	`retainAll(BooleanCollection c, BooleanConsumer r)` A Type-Specific retainAll function that reduces (un)boxing.
`default BooleanSplititerator`	`spliterator()` A Type Specific Type Splititerator to reduce boxing/unboxing
`default BooleanCollection`	`synchronize()` Creates a Wrapped Collection that is Synchronized
`default BooleanCollection`	`synchronize(java.lang.Object mutex)` Creates a Wrapped Collection that is Synchronized
`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.
`default BooleanCollection`	`unmodifiable()` Creates a Wrapped Collection that is unmodifiable

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
arrayflatMap, asAsync, count, distinct, filter, findFirst, flatMap, forEach, forEach, forEach, limit, map, matchesAll, matchesAny, matchesNone, peek, pourAsList, reduce, reduce, sorted

- 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
  - addAll
```
default boolean addAll(boolean... e)
```
    A Type-Specific Array based addAll method to reduce the amount of Wrapping
    
    Parameters:
    
    e - the elements that should be added
    
    Returns:
    
    if the collection was modified
  - addAll
```
default boolean addAll(boolean[] e,
                       int length)
```
    A Type-Specific Array based addAll method to reduce the amount of Wrapping
    
    Parameters:
    
    e - the elements that should be added
    
    length - how many elements of the array should be added
    
    Returns:
    
    if the collection was modified
  - addAll
```
default boolean addAll(boolean[] e,
                       int offset,
                       int length)
```
    A Type-Specific Array based addAll method to reduce the amount of Wrapping
    
    Parameters:
    
    e - the elements that should be added
    
    offset - where to start within the array
    
    length - how many elements of the array should be added
    
    Returns:
    
    if the collection was modified
  - 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)
  - removeAll
```
boolean removeAll(BooleanCollection c,
                  BooleanConsumer r)
```
    A Type-Specific removeAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.
    
    Parameters:
    
    c - the collection of elements that should be removed
    
    r - elements that got 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)
  - retainAll
```
boolean retainAll(BooleanCollection c,
                  BooleanConsumer r)
```
    A Type-Specific retainAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.
    
    Parameters:
    
    c - the collection of elements that should be kept
    
    r - elements that got removed
    
    Returns:
    
    true if any element was removed
    
    See Also:
    
    Collection.retainAll(Collection)
  - pour
```
default <E extends BooleanCollection> E pour(E collection)
```
    A Helper function to reduce the usage of Streams and allows to collect all elements
    
    Specified by:
    
    pour in interface BooleanIterable
    
    Type Parameters:
    
    E - the collection type
    
    Parameters:
    
    collection - that the elements should be inserted to
    
    Returns:
    
    the input with the desired elements
  - copy
```
BooleanCollection copy()
```
    A Function that does a shallow clone of the Collection itself. This function is more optimized then a copy constructor since the Collection does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk
    
    Returns:
    
    a Shallow Copy of the collection
    
    Note:
    
    Wrappers and view collections will not support this feature
  - 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()
  - synchronize
```
default BooleanCollection synchronize()
```
    Creates a Wrapped Collection that is Synchronized
    
    Returns:
    
    a new Collection that is synchronized
    
    See Also:
    
    BooleanCollections.synchronize(speiger.src.collections.booleans.collections.BooleanCollection)
  - synchronize
```
default BooleanCollection synchronize(java.lang.Object mutex)
```
    Creates a Wrapped Collection that is Synchronized
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new Collection Wrapper that is synchronized
    
    See Also:
    
    BooleanCollections.synchronize(speiger.src.collections.booleans.collections.BooleanCollection)
  - unmodifiable
```
default BooleanCollection unmodifiable()
```
    Creates a Wrapped Collection that is unmodifiable
    
    Returns:
    
    a new Collection Wrapper that is unmodifiable
    
    See Also:
    
    BooleanCollections.unmodifiable(speiger.src.collections.booleans.collections.BooleanCollection)
  - 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

Interface BooleanCollection

Method Summary

Methods inherited from interface java.util.Collection

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

Method Detail

add

addAll

addAll

addAll

addAll

contains

containsAll

containsAny

containsAny

remBoolean

removeAll

removeAll

retainAll

retainAll

pour

copy

toBooleanArray

toBooleanArray

add

contains

remove

iterator

synchronize

synchronize

unmodifiable

spliterator