BooleanList (Primitive-Collections 0.8.0 API)

All Superinterfaces:

BooleanCollection, BooleanIterable, java.util.Collection<java.lang.Boolean>, ISizeProvider, java.lang.Iterable<java.lang.Boolean>, java.util.List<java.lang.Boolean>

All Known Implementing Classes:

AbstractBooleanList, BooleanArrayList, BooleanLinkedList, CopyOnWriteBooleanArrayList, ImmutableBooleanList
```
public interface BooleanList
extends BooleanCollection, java.util.List<java.lang.Boolean>
```
A Type Specific List interface that reduces boxing/unboxing and adds a couple extra quality of life features

Nested Class Summary
- Nested classes/interfaces inherited from interface speiger.src.collections.utils.ISizeProvider
  ISizeProvider.CollectionSize

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(boolean e)` A Type-Specific add Function to reduce (un)boxing
`default boolean`	`add(java.lang.Boolean e)` Deprecated. Please use the corresponding type-specific function instead.
`void`	`add(int index, boolean e)` A Type-Specific add Function to reduce (un)boxing
`boolean`	`addAll(BooleanList c)` A Type-Specific and optimized addAll function that allows a faster transfer of elements
`boolean`	`addAll(int index, BooleanCollection c)` A Type-Specific addAll Function to reduce (un)boxing
`boolean`	`addAll(int index, BooleanList c)` A Type-Specific and optimized addAll function that allows a faster transfer of elements
`default void`	`addElements(boolean... a)` A function to fast add elements to the list
`default void`	`addElements(int from, boolean... a)` A function to fast add elements to the list
`void`	`addElements(int from, boolean[] a, int offset, int length)` A function to fast add elements to the list
`default boolean`	`addIfAbsent(boolean e)` A Helper function that will only add elements if it is not present.
`default boolean`	`addIfPresent(boolean e)` A Helper function that will only add elements if it is present.
`default boolean`	`contains(java.lang.Object o)` Deprecated. Please use the corresponding type-specific function instead.
`BooleanList`	`copy()` A Function that does a shallow clone of the Collection itself.
`boolean[]`	`extractElements(int from, int to)` A function to fast extract elements out of the list, this removes the elements that were fetched.
`default void`	`forEachIndexed(IntBooleanConsumer action)` A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
`default java.lang.Boolean`	`get(int index)` Deprecated. Please use the corresponding type-specific function instead.
`boolean`	`getBoolean(int index)` A Type-Specific get function to reduce (un)boxing
`default boolean[]`	`getElements(int from, boolean[] a)` A function to fast fetch elements from the list
`boolean[]`	`getElements(int from, boolean[] a, int offset, int length)` A function to fast fetch elements from the list
`int`	`indexOf(boolean e)` A Type-Specific indexOf function to reduce (un)boxing
`default int`	`indexOf(java.lang.Object o)` Deprecated. Please use the corresponding type-specific function instead.
`int`	`lastIndexOf(boolean e)` A Type-Specific lastIndexOf function to reduce (un)boxing
`default int`	`lastIndexOf(java.lang.Object o)` Deprecated. Please use the corresponding type-specific function instead.
`BooleanListIterator`	`listIterator()` A Type-Specific Iterator of listIterator
`BooleanListIterator`	`listIterator(int index)` A Type-Specific Iterator of listIterator
`default java.lang.Boolean`	`remove(int index)` Deprecated. Please use the corresponding type-specific function instead.
`default boolean`	`remove(java.lang.Object o)` Deprecated. Please use the corresponding type-specific function instead.
`boolean`	`removeBoolean(int index)` A Type-Specific remove function to reduce (un)boxing
`void`	`removeElements(int from, int to)` a function to fast remove elements from the list.
`boolean`	`set(int index, boolean e)` A Type-Specific set function to reduce (un)boxing
`default java.lang.Boolean`	`set(int index, java.lang.Boolean e)` Deprecated. Please use the corresponding type-specific function instead.
`void`	`size(int size)` A function to ensure the elements are within the requested size.
`default void`	`sort(BooleanComparator c)` Sorts the elements specified by the Natural order either by using the Comparator or the elements
`default void`	`sort(java.util.Comparator<? super java.lang.Boolean> c)` Deprecated. Please use the corresponding type-specific function instead.
`default BooleanSplititerator`	`spliterator()` A Type Specific Type Splititerator to reduce boxing/unboxing
`BooleanList`	`subList(int from, int to)` A Type-Specific List of subList
`boolean`	`swapRemove(int index)` A Highly Optimized remove function that removes the desired element.
`boolean`	`swapRemoveBoolean(boolean e)` A Highly Optimized remove function that removes the desired element.
`default BooleanList`	`synchronize()` Creates a Wrapped List that is Synchronized
`default BooleanList`	`synchronize(java.lang.Object mutex)` Creates a Wrapped List that is Synchronized
`default BooleanList`	`unmodifiable()` Creates a Wrapped List that is unmodifiable
`default void`	`unstableSort(BooleanComparator c)` Sorts the elements specified by the Natural order either by using the Comparator or the elements using a unstable sort
`default void`	`unstableSort(java.util.Comparator<? super java.lang.Boolean> c)` Deprecated. Please use the corresponding type-specific function instead.

Methods inherited from interface speiger.src.collections.booleans.collections.BooleanCollection
addAll, addAll, addAll, addAll, contains, containsAll, containsAny, containsAny, iterator, pour, remBoolean, removeAll, removeAll, retainAll, retainAll, toBooleanArray, toBooleanArray

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, repeat, sorted

Methods inherited from interface speiger.src.collections.utils.ISizeProvider
of, size

Methods inherited from interface java.util.List
add, addAll, addAll, clear, containsAll, equals, hashCode, isEmpty, iterator, removeAll, replaceAll, retainAll, size, toArray, toArray

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

- Method Detail
  - add
```
boolean add(boolean e)
```
    A Type-Specific add Function to reduce (un)boxing
    
    Specified by:
    
    add in interface BooleanCollection
    
    Parameters:
    
    e - the element to add
    
    Returns:
    
    true if the list was modified
    
    See Also:
    
    List.add(Object)
  - add
```
void add(int index,
         boolean e)
```
    A Type-Specific add Function to reduce (un)boxing
    
    Parameters:
    
    e - the element to add
    
    index - index at which the specified element is to be inserted
    
    See Also:
    
    List.add(int, Object)
  - addIfAbsent
```
default boolean addIfAbsent(boolean e)
```
    A Helper function that will only add elements if it is not present.
    
    Parameters:
    
    e - the element to add
    
    Returns:
    
    true if the list was modified
  - addIfPresent
```
default boolean addIfPresent(boolean e)
```
    A Helper function that will only add elements if it is present.
    
    Parameters:
    
    e - the element to add
    
    Returns:
    
    true if the list was modified
  - addAll
```
boolean addAll(int index,
               BooleanCollection c)
```
    A Type-Specific addAll Function to reduce (un)boxing
    
    Parameters:
    
    c - the elements that need to be added
    
    index - index at which the specified elements is to be inserted
    
    Returns:
    
    true if the list was modified
    
    See Also:
    
    List.addAll(int, java.util.Collection)
  - addAll
```
boolean addAll(BooleanList c)
```
    A Type-Specific and optimized addAll function that allows a faster transfer of elements
    
    Parameters:
    
    c - the elements that need to be added
    
    Returns:
    
    true if the list was modified
  - addAll
```
boolean addAll(int index,
               BooleanList c)
```
    A Type-Specific and optimized addAll function that allows a faster transfer of elements
    
    Parameters:
    
    c - the elements that need to be added
    
    index - index at which the specified elements is to be inserted
    
    Returns:
    
    true if the list was modified
  - getBoolean
```
boolean getBoolean(int index)
```
    A Type-Specific get function to reduce (un)boxing
    
    Parameters:
    
    index - the index of the value that is requested
    
    Returns:
    
    the value at the given index
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index is not within the list range
    
    See Also:
    
    List.get(int)
  - set
```
boolean set(int index,
            boolean e)
```
    A Type-Specific set function to reduce (un)boxing
    
    Parameters:
    
    index - index of the element to replace
    
    e - element to be stored at the specified position
    
    Returns:
    
    the element previously at the specified position
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index is not within the list range
    
    See Also:
    
    List.set(int, Object)
  - removeBoolean
```
boolean removeBoolean(int index)
```
    A Type-Specific remove function to reduce (un)boxing
    
    Parameters:
    
    index - the index of the element to be removed
    
    Returns:
    
    the element previously at the specified position
    
    See Also:
    
    List.remove(int)
  - indexOf
```
int indexOf(boolean e)
```
    A Type-Specific indexOf function to reduce (un)boxing
    
    Parameters:
    
    e - the element that is searched for
    
    Returns:
    
    the index of the element if found. (if not found then -1)
    
    Note:
    
    does not support null values
  - lastIndexOf
```
int lastIndexOf(boolean e)
```
    A Type-Specific lastIndexOf function to reduce (un)boxing
    
    Parameters:
    
    e - the element that is searched for
    
    Returns:
    
    the lastIndex of the element if found. (if not found then -1)
    
    Note:
    
    does not support null values
  - addElements
```
default void addElements(boolean... a)
```
    A function to fast add elements to the list
    
    Parameters:
    
    a - the elements that should be added
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if from is outside of the lists range
  - addElements
```
default void addElements(int from,
                         boolean... a)
```
    A function to fast add elements to the list
    
    Parameters:
    
    from - the index where the elements should be added into the list
    
    a - the elements that should be added
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if from is outside of the lists range
  - addElements
```
void addElements(int from,
                 boolean[] a,
                 int offset,
                 int length)
```
    A function to fast add elements to the list
    
    Parameters:
    
    from - the index where the elements should be added into the list
    
    a - the elements that should be added
    
    offset - the start index of the array should be read from
    
    length - how many elements should be read from
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if from is outside of the lists range
  - getElements
```
default boolean[] getElements(int from,
                              boolean[] a)
```
    A function to fast fetch elements from the list
    
    Parameters:
    
    from - index where the list should be fetching elements from
    
    a - the array where the values should be inserted to
    
    Returns:
    
    the inputArray
    
    Throws:
    
    java.lang.NullPointerException - if the array is null
    
    java.lang.IndexOutOfBoundsException - if from is outside of the lists range
    
    java.lang.IllegalStateException - if offset or length are smaller then 0 or exceed the array length
  - getElements
```
boolean[] getElements(int from,
                      boolean[] a,
                      int offset,
                      int length)
```
    A function to fast fetch elements from the list
    
    Parameters:
    
    from - index where the list should be fetching elements from
    
    a - the array where the values should be inserted to
    
    offset - the startIndex of where the array should be written to
    
    length - the number of elements the values should be fetched from
    
    Returns:
    
    the inputArray
    
    Throws:
    
    java.lang.NullPointerException - if the array is null
    
    java.lang.IndexOutOfBoundsException - if from is outside of the lists range
    
    java.lang.IllegalStateException - if offset or length are smaller then 0 or exceed the array length
  - removeElements
```
void removeElements(int from,
                    int to)
```
    a function to fast remove elements from the list.
    
    Parameters:
    
    from - the start index of where the elements should be removed from (inclusive)
    
    to - the end index of where the elements should be removed to (exclusive)
  - swapRemove
```
boolean swapRemove(int index)
```
    A Highly Optimized remove function that removes the desired element. But instead of shifting the elements to the left it moves the last element to the removed space.
    
    Parameters:
    
    index - the index of the element to be removed
    
    Returns:
    
    the element previously at the specified position
  - swapRemoveBoolean
```
boolean swapRemoveBoolean(boolean e)
```
    A Highly Optimized remove function that removes the desired element. But instead of shifting the elements to the left it moves the last element to the removed space.
    
    Parameters:
    
    e - the element that should be removed
    
    Returns:
    
    true if the element was removed
  - extractElements
```
boolean[] extractElements(int from,
                          int to)
```
    A function to fast extract elements out of the list, this removes the elements that were fetched.
    
    Parameters:
    
    from - the start index of where the elements should be fetched from (inclusive)
    
    to - the end index of where the elements should be fetched to (exclusive)
    
    Returns:
    
    a array of the elements that were fetched
  - sort
```
@Deprecated
default void sort(java.util.Comparator<? super java.lang.Boolean> c)
```
    Deprecated. Please use the corresponding type-specific function instead.
    
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    sort in interface java.util.List<java.lang.Boolean>
  - sort
```
default void sort(BooleanComparator c)
```
    Sorts the elements specified by the Natural order either by using the Comparator or the elements
    
    Parameters:
    
    c - the sorter of the elements, can be null
    
    See Also:
    
    List.sort(Comparator), BooleanArrays.stableSort(boolean[], BooleanComparator)
  - unstableSort
```
@Deprecated
default void unstableSort(java.util.Comparator<? super java.lang.Boolean> c)
```
    Deprecated. Please use the corresponding type-specific function instead.
    
    This default implementation delegates to the corresponding type-specific function.
    
    Parameters:
    
    c - the sorter of the elements, can be null
  - unstableSort
```
default void unstableSort(BooleanComparator c)
```
    Sorts the elements specified by the Natural order either by using the Comparator or the elements using a unstable sort
    
    Parameters:
    
    c - the sorter of the elements, can be null
    
    See Also:
    
    List.sort(Comparator), BooleanArrays.unstableSort(boolean[], BooleanComparator)
  - forEachIndexed
```
default void forEachIndexed(IntBooleanConsumer action)
```
    A Indexed forEach implementation that allows you to keep track of how many elements were already iterated over.
    
    Specified by:
    
    forEachIndexed in interface BooleanIterable
    
    Parameters:
    
    action - The action to be performed for each element
    
    Throws:
    
    java.lang.NullPointerException - if the specified action is null
  - listIterator
```
BooleanListIterator listIterator()
```
    A Type-Specific Iterator of listIterator
    
    Specified by:
    
    listIterator in interface java.util.List<java.lang.Boolean>
    
    See Also:
    
    List.listIterator()
  - listIterator
```
BooleanListIterator listIterator(int index)
```
    A Type-Specific Iterator of listIterator
    
    Specified by:
    
    listIterator in interface java.util.List<java.lang.Boolean>
    
    See Also:
    
    List.listIterator(int)
  - subList
```
BooleanList subList(int from,
                    int to)
```
    A Type-Specific List of subList
    
    Specified by:
    
    subList in interface java.util.List<java.lang.Boolean>
    
    See Also:
    
    List.subList(int, int)
  - synchronize
```
default BooleanList synchronize()
```
    Creates a Wrapped List that is Synchronized
    
    Specified by:
    
    synchronize in interface BooleanCollection
    
    Returns:
    
    a new List that is synchronized
    
    See Also:
    
    BooleanLists.synchronize(speiger.src.collections.booleans.lists.BooleanList)
  - synchronize
```
default BooleanList synchronize(java.lang.Object mutex)
```
    Creates a Wrapped List that is Synchronized
    
    Specified by:
    
    synchronize in interface BooleanCollection
    
    Parameters:
    
    mutex - is the controller of the synchronization block
    
    Returns:
    
    a new List Wrapper that is synchronized
    
    See Also:
    
    BooleanLists.synchronize(speiger.src.collections.booleans.lists.BooleanList)
  - unmodifiable
```
default BooleanList unmodifiable()
```
    Creates a Wrapped List that is unmodifiable
    
    Specified by:
    
    unmodifiable in interface BooleanCollection
    
    Returns:
    
    a new List Wrapper that is unmodifiable
    
    See Also:
    
    BooleanLists.unmodifiable(speiger.src.collections.booleans.lists.BooleanList)
  - size
```
void size(int size)
```
    A function to ensure the elements are within the requested size. If smaller then the stored elements they get removed as needed. If bigger it is ensured that enough room is provided depending on the implementation
    
    Parameters:
    
    size - the requested amount of elements/room for elements
  - copy
```
BooleanList copy()
```
    Description copied from interface: BooleanCollection
    
    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
    
    Specified by:
    
    copy in interface BooleanCollection
    
    Returns:
    
    a Shallow Copy of the collection
  - add
```
@Deprecated
default boolean add(java.lang.Boolean e)
```
    Deprecated. Please use the corresponding type-specific function instead.
    
    This default implementation delegates to the corresponding type-specific function.
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    add in interface BooleanCollection
    
    Specified by:
    
    add in interface java.util.Collection<java.lang.Boolean>
    
    Specified by:
    
    add in interface java.util.List<java.lang.Boolean>
  - get
```
@Deprecated
default java.lang.Boolean get(int index)
```
    Deprecated. Please use the corresponding type-specific function instead.
    
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    get in interface java.util.List<java.lang.Boolean>
  - set
```
@Deprecated
default java.lang.Boolean set(int index,
                                           java.lang.Boolean e)
```
    Deprecated. Please use the corresponding type-specific function instead.
    
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    set in interface java.util.List<java.lang.Boolean>
  - indexOf
```
@Deprecated
default int indexOf(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:
    
    indexOf in interface java.util.List<java.lang.Boolean>
  - lastIndexOf
```
@Deprecated
default int lastIndexOf(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:
    
    lastIndexOf in interface java.util.List<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.
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    contains in interface BooleanCollection
    
    Specified by:
    
    contains in interface java.util.Collection<java.lang.Boolean>
    
    Specified by:
    
    contains in interface java.util.List<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.
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    remove in interface BooleanCollection
    
    Specified by:
    
    remove in interface java.util.Collection<java.lang.Boolean>
    
    Specified by:
    
    remove in interface java.util.List<java.lang.Boolean>
  - remove
```
@Deprecated
default java.lang.Boolean remove(int index)
```
    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.List<java.lang.Boolean>
  - spliterator
```
default BooleanSplititerator spliterator()
```
    A Type Specific Type Splititerator to reduce boxing/unboxing
    
    Specified by:
    
    spliterator in interface BooleanCollection
    
    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>
    
    Specified by:
    
    spliterator in interface java.util.List<java.lang.Boolean>
    
    Returns:
    
    type specific splititerator

Interface BooleanList

Nested Class Summary

Nested classes/interfaces inherited from interface speiger.src.collections.utils.ISizeProvider

Method Summary

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

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

Methods inherited from interface speiger.src.collections.utils.ISizeProvider

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Method Detail

add

add

addIfAbsent

addIfPresent

addAll

addAll

addAll

getBoolean

set

removeBoolean

indexOf

lastIndexOf

addElements

addElements

addElements

getElements

getElements

removeElements

swapRemove

swapRemoveBoolean

extractElements

sort

sort

unstableSort

unstableSort

forEachIndexed

listIterator

listIterator

subList

synchronize

synchronize

unmodifiable

size

copy

add

get

set

indexOf

lastIndexOf

contains

remove

remove

spliterator