speiger.src.collections.booleans.lists

Class BooleanArrayList

java.lang.Object

java.util.AbstractCollection<java.lang.Boolean>

speiger.src.collections.booleans.collections.AbstractBooleanCollection

speiger.src.collections.booleans.lists.AbstractBooleanList

speiger.src.collections.booleans.lists.BooleanArrayList

All Implemented Interfaces:

java.lang.Iterable<java.lang.Boolean>, java.util.Collection<java.lang.Boolean>, java.util.List<java.lang.Boolean>, java.util.RandomAccess, BooleanCollection, BooleanIterable, BooleanStack, BooleanList, IBooleanArray, IArray, ITrimmable

public class BooleanArrayList
extends AbstractBooleanList
implements IBooleanArray, BooleanStack

A Type-Specific Array-based implementation of list that is written to reduce (un)boxing

This implementation is optimized to improve how data is processed with interfaces like IBooleanArray, BooleanStack and with optimized functions that use type-specific implementations for primitives and optimized logic for bulkactions.

Constructor Summary

Constructors

Constructor and Description
BooleanArrayList() Creates a new ArrayList with a Empty array.
BooleanArrayList(boolean... a) Creates a new ArrayList with a Copy of the array
BooleanArrayList(boolean[] a, int length) Creates a new ArrayList with a Copy of the array with a custom length
BooleanArrayList(boolean[] a, int offset, int length) Creates a new ArrayList with a Copy of the array with in the custom range.
BooleanArrayList(BooleanCollection c) Creates a new ArrayList a copy with the contents of the Collection.
BooleanArrayList(BooleanList l) Creates a new ArrayList a copy with the contents of the List.
BooleanArrayList(java.util.Collection<? extends java.lang.Boolean> c) Deprecated.
BooleanArrayList(int size) Creates a new ArrayList with the specific requested size

Method Summary

Modifier and Type	Method and Description
boolean	add(boolean e) Appends the specified element to the end of this list.
void	add(int index, boolean e) Appends the specified element to the index of the list
boolean	addAll(boolean[] e, int offset, int length) A Type-Specific Array based addAll method to reduce the amount of Wrapping
boolean	addAll(int index, BooleanCollection c) Appends the specified elements to the index of the list.
boolean	addAll(int index, BooleanList c) Appends the specified elements to the index of the list.
boolean	addAll(int index, java.util.Collection<? extends java.lang.Boolean> c) Deprecated.
void	addElements(int from, boolean[] a, int offset, int length) Appends the specified array elements to the index of the list.
void	clear() A function to clear all elements in the list.
void	clearAndTrim(int size) Trims the collection down to the requested size and clears all elements while doing so
boolean	contains(boolean e) A Type Specific implementation of the Collection#contains function.
boolean	contains(java.lang.Object o) Deprecated.
BooleanArrayList	copy() A Function that does a shallow clone of the Collection itself.
int	count(Boolean2BooleanFunction filter) Helper function to reduce stream usage that allows to count the valid elements.
boolean[]	elements() Provides the Underlying Array in the Implementation
void	ensureCapacity(int size) Increases the capacity of this implementation instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.
boolean[]	extractElements(int from, int to) A function to fast extract elements out of the list, this removes the elements that were fetched.
boolean	findFirst(Boolean2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for the first match.
void	forEach(BooleanConsumer action) A Type Specific foreach function that reduces (un)boxing
<E> void	forEach(E input, ObjectBooleanConsumer<E> action) Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
boolean	getBoolean(int index) A Type-Specific get function to reduce (un)boxing
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 function to find the index of a given element
int	indexOf(java.lang.Object o) Deprecated.
int	lastIndexOf(boolean e) A Type-Specific function to find the last index of a given element
int	lastIndexOf(java.lang.Object o) Deprecated.
boolean	matchesAll(Boolean2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for all matches.
boolean	matchesAny(Boolean2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for any matches.
boolean	matchesNone(Boolean2BooleanFunction filter) Helper function to reduce stream usage that allows to filter for no matches.
boolean	peek(int index) Provides the Selected Object from the stack.
boolean	pop() A Type-Specific pop function to reduce (un)boxing
void	push(boolean e) Appends the specified element to the end of this Stack.
boolean	reduce(boolean identity, BooleanBooleanUnaryOperator operator) Performs a reduction on the elements of this Iterable
boolean	reduce(BooleanBooleanUnaryOperator operator) Performs a reduction on the elements of this Iterable
boolean	remBoolean(boolean type) A Type-Specific implementation of remove.
boolean	removeAll(BooleanCollection c) A function to remove all elements that were provided in the other collection
boolean	removeAll(BooleanCollection c, BooleanConsumer r) A Type-Specific removeAll function that reduces (un)boxing.
boolean	removeAll(java.util.Collection<?> c) Deprecated.
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	removeIf(java.util.function.Predicate<? super java.lang.Boolean> filter) Deprecated.
void	replaceAll(java.util.function.UnaryOperator<java.lang.Boolean> o) Deprecated.
boolean	retainAll(BooleanCollection c) A function to retain all elements that were provided in the other collection This function might delegate to a more appropriate function if necessary
boolean	retainAll(BooleanCollection c, BooleanConsumer r) A Type-Specific retainAll function that reduces (un)boxing.
boolean	retainAll(java.util.Collection<?> c) Deprecated.
boolean	set(int index, boolean e) A Type-Specific set function to reduce (un)boxing
int	size() A function to return the size of the list
void	size(int size) A function to ensure the elements are within the requested size.
void	sort(BooleanComparator c) Sorts the elements specified by the Natural order either by using the Comparator or the elements
BooleanSplititerator	spliterator() A Type Specific Type Splititerator to reduce boxing/unboxing
boolean	swapRemove(int index) A Highly Optimized remove function that removes the desired element.
java.lang.Object[]	toArray() Deprecated.
<E> E[]	toArray(E[] a) Deprecated.
boolean[]	toBooleanArray(boolean[] a) A Type-Specific implementation of toArray.
boolean	trim(int size) Trims the original collection down to the size of the current elements or the requested size depending which is bigger
void	unstableSort(BooleanComparator c) Sorts the elements specified by the Natural order either by using the Comparator or the elements using a unstable sort
static BooleanArrayList	wrap(boolean... a) Creates a wrapped arraylist that uses the array as backing array
static BooleanArrayList	wrap(boolean[] a, int length) Creates a wrapped arraylist that uses the array as backing array and a custom fill size

Methods inherited from class speiger.src.collections.booleans.lists.AbstractBooleanList

add, addAll, addAll, addAll, equals, hashCode, iterator, listIterator, listIterator, subList, swapRemoveBoolean

Methods inherited from class speiger.src.collections.booleans.collections.AbstractBooleanCollection

add, containsAll, containsAll, containsAny, containsAny, remove, toBooleanArray

Methods inherited from class java.util.AbstractCollection

isEmpty, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.booleans.utils.IBooleanArray

elements

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

clearAndTrim, trim

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

isEmpty, top

Methods inherited from interface speiger.src.collections.booleans.lists.BooleanList

add, addElements, addElements, addIfAbsent, addIfPresent, get, getElements, remove, remove, set, sort, synchronize, synchronize, unmodifiable, unstableSort

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

addAll, addAll, containsAll, containsAny, containsAny, pour, toBooleanArray

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

arrayflatMap, asAsync, distinct, filter, flatMap, forEach, limit, map, peek, pourAsList, sorted

Methods inherited from interface java.util.List

containsAll, isEmpty

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

BooleanArrayList

public BooleanArrayList()

Creates a new ArrayList with a Empty array.

BooleanArrayList

public BooleanArrayList(int size)

Creates a new ArrayList with the specific requested size

Parameters:

size - the minimum initial size of the Backing array

BooleanArrayList

@Deprecated
public BooleanArrayList(java.util.Collection<? extends java.lang.Boolean> c)

Deprecated.

Creates a new ArrayList a copy with the contents of the Collection.

Parameters:

c - the elements that should be added into the list

BooleanArrayList

public BooleanArrayList(BooleanCollection c)

Creates a new ArrayList a copy with the contents of the Collection.

Parameters:

c - the elements that should be added into the list

BooleanArrayList

public BooleanArrayList(BooleanList l)

Creates a new ArrayList a copy with the contents of the List.

Parameters:

l - the elements that should be added into the list

BooleanArrayList

public BooleanArrayList(boolean... a)

Creates a new ArrayList with a Copy of the array

Parameters:

a - the array that should be copied

BooleanArrayList

public BooleanArrayList(boolean[] a,
                        int length)

Creates a new ArrayList with a Copy of the array with a custom length

Parameters:

a - the array that should be copied

length - the desired length that should be copied

BooleanArrayList

public BooleanArrayList(boolean[] a,
                        int offset,
                        int length)

Creates a new ArrayList with a Copy of the array with in the custom range.

Parameters:

a - the array that should be copied

offset - the starting offset of where the array should be copied from

length - the desired length that should be copied

Throws:

java.lang.IllegalStateException - if offset is smaller then 0

java.lang.IllegalStateException - if the offset + length exceeds the array length

Method Detail

wrap

public static BooleanArrayList wrap(boolean... a)

Creates a wrapped arraylist that uses the array as backing array

Parameters:

a - elements that should be wrapped

Returns:

a Wrapped list using the input array

wrap

public static BooleanArrayList wrap(boolean[] a,
                                    int length)

Creates a wrapped arraylist that uses the array as backing array and a custom fill size

Parameters:

a - elements that should be wrapped

length - the size of the elements within the array

Returns:

a Wrapped list using the input array

add

public boolean add(boolean e)

Appends the specified element to the end of this list.

Specified by:

add in interface BooleanCollection

Specified by:

add in interface BooleanList

Overrides:

add in class AbstractBooleanList

Parameters:

e - element to be appended to this list

Returns:

true (as specified by Collection.add(E))

See Also:

List.add(Object)

push

public void push(boolean e)

Appends the specified element to the end of this Stack.

Specified by:

push in interface BooleanStack

Parameters:

e - element to be appended to this Stack

See Also:

Stack.push(Object)

add

public void add(int index,
                boolean e)

Appends the specified element to the index of the list

Specified by:

add in interface BooleanList

Parameters:

index - the index where to append the element to

e - the element to append to the list

Throws:

java.lang.IndexOutOfBoundsException - if index is outside of the lists range

See Also:

List.add(int, Object)

addAll

@Deprecated
public boolean addAll(int index,
                                   java.util.Collection<? extends java.lang.Boolean> c)

Deprecated.

Appends the specified elements to the index of the list. This function may delegate to more appropriate function if necessary

Specified by:

addAll in interface java.util.List<java.lang.Boolean>

Parameters:

index - the index where to append the elements to

c - the elements to append to the list

Throws:

java.lang.IndexOutOfBoundsException - if index is outside of the lists range

java.lang.NullPointerException - if collection contains a null element

addAll

public boolean addAll(int index,
                      BooleanCollection c)

Appends the specified elements to the index of the list. This function may delegate to more appropriate function if necessary

Specified by:

addAll in interface BooleanList

Parameters:

index - the index where to append the elements to

c - the elements to append to the list

Returns:

true if the list was modified

Throws:

java.lang.IndexOutOfBoundsException - if index is outside of the lists range

See Also:

List.addAll(int, java.util.Collection)

addAll

public boolean addAll(int index,
                      BooleanList c)

Appends the specified elements to the index of the list.

Specified by:

addAll in interface BooleanList

Parameters:

index - the index where to append the elements to

c - the elements to append to the list

Returns:

true if the list was modified

Throws:

java.lang.IndexOutOfBoundsException - if index is outside of the lists range

addAll

public boolean addAll(boolean[] e,
                      int offset,
                      int length)

Description copied from interface: BooleanCollection

A Type-Specific Array based addAll method to reduce the amount of Wrapping

Specified by:

addAll in interface BooleanCollection

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

addElements

public void addElements(int from,
                        boolean[] a,
                        int offset,
                        int length)

Appends the specified array elements to the index of the list.

Specified by:

addElements in interface BooleanList

Parameters:

from - the index where to append the elements to

a - the elements to append to the list

offset - where to start ino the array

length - the amount of elements to insert

Throws:

java.lang.IndexOutOfBoundsException - if index is outside of the lists range

getElements

public boolean[] getElements(int from,
                             boolean[] a,
                             int offset,
                             int length)

A function to fast fetch elements from the list

Specified by:

getElements in interface BooleanList

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

public void removeElements(int from,
                           int to)

a function to fast remove elements from the list.

Specified by:

removeElements in interface BooleanList

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)

extractElements

public boolean[] extractElements(int from,
                                 int to)

A function to fast extract elements out of the list, this removes the elements that were fetched.

Specified by:

extractElements in interface BooleanList

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

contains

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

Deprecated.

A function to find if the Element is present in this list.

Specified by:

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

Specified by:

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

Specified by:

contains in interface BooleanCollection

Specified by:

contains in interface BooleanList

Overrides:

contains in class AbstractBooleanCollection

Parameters:

o - the element that is searched for

Returns:

if the element was found.

indexOf

@Deprecated
public int indexOf(java.lang.Object o)

Deprecated.

A function to find the index of a given element

Specified by:

indexOf in interface java.util.List<java.lang.Boolean>

Specified by:

indexOf in interface BooleanList

Overrides:

indexOf in class AbstractBooleanList

Parameters:

o - the element that is searched for

Returns:

the index of the element if found. (if not found then -1)

lastIndexOf

@Deprecated
public int lastIndexOf(java.lang.Object o)

Deprecated.

A function to find the last index of a given element

Specified by:

lastIndexOf in interface java.util.List<java.lang.Boolean>

Specified by:

lastIndexOf in interface BooleanList

Overrides:

lastIndexOf in class AbstractBooleanList

Parameters:

o - the element that is searched for

Returns:

the last index of the element if found. (if not found then -1)

contains

public boolean contains(boolean e)

A Type Specific implementation of the Collection#contains function.

Specified by:

contains in interface BooleanCollection

Overrides:

contains in class AbstractBooleanCollection

Parameters:

e - the element that is searched for.

Returns:

if the element was found

indexOf

public int indexOf(boolean e)

A Type-Specific function to find the index of a given element

Specified by:

indexOf in interface BooleanList

Overrides:

indexOf in class AbstractBooleanList

Parameters:

e - the element that is searched for

Returns:

the index of the element if found. (if not found then -1)

lastIndexOf

public int lastIndexOf(boolean e)

A Type-Specific function to find the last index of a given element

Specified by:

lastIndexOf in interface BooleanList

Overrides:

lastIndexOf in class AbstractBooleanList

Parameters:

e - the element that is searched for

Returns:

the last index of the element if found. (if not found then -1)

sort

public void sort(BooleanComparator c)

Sorts the elements specified by the Natural order either by using the Comparator or the elements

Specified by:

sort in interface BooleanList

Parameters:

c - the sorter of the elements, can be null

See Also:

List.sort(java.util.Comparator), BooleanArrays.stableSort(boolean[], BooleanComparator)

unstableSort

public void unstableSort(BooleanComparator c)

Sorts the elements specified by the Natural order either by using the Comparator or the elements using a unstable sort

Specified by:

unstableSort in interface BooleanList

Parameters:

c - the sorter of the elements, can be null

See Also:

List.sort(java.util.Comparator), BooleanArrays.unstableSort(boolean[], BooleanComparator)

getBoolean

public boolean getBoolean(int index)

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

Specified by:

getBoolean in interface BooleanList

Parameters:

index - the index of the element to fetch

Returns:

the value of the requested index

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range

See Also:

List.get(int)

peek

public boolean peek(int index)

Provides the Selected Object from the stack. Top to bottom

Specified by:

peek in interface BooleanStack

Parameters:

index - of the element that should be provided

Returns:

the element that was requested

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the index is out of bounds

See Also:

Stack.peek(int)

elements

public boolean[] elements()

Provides the Underlying Array in the Implementation

Specified by:

elements in interface IBooleanArray

Returns:

underlying Array

Throws:

java.lang.ClassCastException - if the return type does not match the underlying array. (Only for Object Implementations)

forEach

public void forEach(BooleanConsumer action)

A Type Specific foreach function that reduces (un)boxing

Specified by:

forEach in interface BooleanIterable

Parameters:

action - The action to be performed for each element

Throws:

java.lang.NullPointerException - if the specified action is null

See Also:

Iterable.forEach(java.util.function.Consumer)

ImplSpec:

The default implementation behaves as if:

 	for(int i = 0;i<size;i++)
		action.accept(data[i]);
 

forEach

public <E> void forEach(E input,
                        ObjectBooleanConsumer<E> action)

Description copied from interface: BooleanIterable

Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.

Specified by:

forEach in interface BooleanIterable

Type Parameters:

E - the generic type of the Object

Parameters:

input - the object that should be included

action - The action to be performed for each element

matchesAny

public boolean matchesAny(Boolean2BooleanFunction filter)

Description copied from interface: BooleanIterable

Helper function to reduce stream usage that allows to filter for any matches.

Specified by:

matchesAny in interface BooleanIterable

Parameters:

filter - that should be applied

Returns:

true if any matches were found

matchesNone

public boolean matchesNone(Boolean2BooleanFunction filter)

Description copied from interface: BooleanIterable

Helper function to reduce stream usage that allows to filter for no matches.

Specified by:

matchesNone in interface BooleanIterable

Parameters:

filter - that should be applied

Returns:

true if no matches were found

matchesAll

public boolean matchesAll(Boolean2BooleanFunction filter)

Description copied from interface: BooleanIterable

Helper function to reduce stream usage that allows to filter for all matches.

Specified by:

matchesAll in interface BooleanIterable

Parameters:

filter - that should be applied

Returns:

true if all matches.

findFirst

public boolean findFirst(Boolean2BooleanFunction filter)

Description copied from interface: BooleanIterable

Helper function to reduce stream usage that allows to filter for the first match.

Specified by:

findFirst in interface BooleanIterable

Parameters:

filter - that should be applied

Returns:

the found value or the null equivalent variant.

reduce

public boolean reduce(boolean identity,
                      BooleanBooleanUnaryOperator operator)

Description copied from interface: BooleanIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface BooleanIterable

Parameters:

identity - the start value

operator - the operation that should be applied

Returns:

the reduction result, returns identity if nothing was found

reduce

public boolean reduce(BooleanBooleanUnaryOperator operator)

Description copied from interface: BooleanIterable

Performs a reduction on the elements of this Iterable

Specified by:

reduce in interface BooleanIterable

Parameters:

operator - the operation that should be applied

Returns:

the reduction result, returns null value if nothing was found

count

public int count(Boolean2BooleanFunction filter)

Description copied from interface: BooleanIterable

Helper function to reduce stream usage that allows to count the valid elements.

Specified by:

count in interface BooleanIterable

Parameters:

filter - that should be applied

Returns:

the amount of Valid Elements

set

public boolean set(int index,
                   boolean e)

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

Specified by:

set in interface BooleanList

Parameters:

index - the index of the element to set

e - the value that should be set

Returns:

the previous element

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range

See Also:

List.set(int, Object)

replaceAll

@Deprecated
public void replaceAll(java.util.function.UnaryOperator<java.lang.Boolean> o)

Deprecated.

A function to replace all values in the list

Specified by:

replaceAll in interface java.util.List<java.lang.Boolean>

Parameters:

o - the action to replace the values

Throws:

java.lang.NullPointerException - if o is null

removeBoolean

public boolean removeBoolean(int index)

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

Specified by:

removeBoolean in interface BooleanList

Parameters:

index - the index of the element to fetch

Returns:

the value of the requested index

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range

See Also:

List.remove(int)

swapRemove

public boolean swapRemove(int index)

Description copied from interface: BooleanList

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.

Specified by:

swapRemove in interface BooleanList

Parameters:

index - the index of the element to be removed

Returns:

the element previously at the specified position

remBoolean

public boolean remBoolean(boolean type)

A Type-Specific implementation of remove. This implementation iterates over the elements until it finds the element that is searched for or it runs out of elements. It stops after finding the first element

Specified by:

remBoolean in interface BooleanCollection

Overrides:

remBoolean in class AbstractBooleanCollection

Parameters:

type - the element that is searched for

Returns:

true if the element was found and removed.

See Also:

Collection.remove(Object)

pop

public boolean pop()

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

Specified by:

pop in interface BooleanStack

Returns:

the value of the requested index

Throws:

java.lang.IndexOutOfBoundsException - if the index is out of range

See Also:

Stack.pop()

removeAll

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

Deprecated.

A function to remove all elements that were provided in the other collection This function might delegate to a more appropriate function if necessary

Specified by:

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

Specified by:

removeAll in interface java.util.List<java.lang.Boolean>

Overrides:

removeAll in class java.util.AbstractCollection<java.lang.Boolean>

Parameters:

c - the elements that should be removed

Returns:

true if the collection was modified

Throws:

java.lang.NullPointerException - if the collection is null

retainAll

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

Deprecated.

A function to retain all elements that were provided in the other collection This function might delegate to a more appropriate function if necessary

Specified by:

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

Specified by:

retainAll in interface java.util.List<java.lang.Boolean>

Overrides:

retainAll in class java.util.AbstractCollection<java.lang.Boolean>

Parameters:

c - the elements that should be kept. If empty, BooleanArrayList#clear is called.

Returns:

true if the collection was modified

Throws:

java.lang.NullPointerException - if the collection is null

removeIf

@Deprecated
public boolean removeIf(java.util.function.Predicate<? super java.lang.Boolean> filter)

Deprecated.

A optimized List#removeIf(Predicate) that more quickly removes elements from the list then the ArrayList implementation

Specified by:

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

Parameters:

filter - the filter to remove elements

Returns:

true if the list was modified

removeAll

public boolean removeAll(BooleanCollection c)

A function to remove all elements that were provided in the other collection

Specified by:

removeAll in interface BooleanCollection

Overrides:

removeAll in class AbstractBooleanCollection

Parameters:

c - the elements that should be removed

Returns:

true if the collection was modified

Throws:

java.lang.NullPointerException - if the collection is null

See Also:

Collection.removeAll(Collection)

removeAll

public boolean removeAll(BooleanCollection c,
                         BooleanConsumer r)

Description copied from interface: BooleanCollection

A Type-Specific removeAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.

Specified by:

removeAll in interface BooleanCollection

Overrides:

removeAll in class AbstractBooleanCollection

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

public boolean retainAll(BooleanCollection c)

A function to retain all elements that were provided in the other collection This function might delegate to a more appropriate function if necessary

Specified by:

retainAll in interface BooleanCollection

Overrides:

retainAll in class AbstractBooleanCollection

Parameters:

c - the elements that should be kept. If empty, BooleanArrayList#clear is called.

Returns:

true if the collection was modified

Throws:

java.lang.NullPointerException - if the collection is null

See Also:

Collection.retainAll(Collection)

retainAll

public boolean retainAll(BooleanCollection c,
                         BooleanConsumer r)

Description copied from interface: BooleanCollection

A Type-Specific retainAll function that reduces (un)boxing. It also notifies the remover of which exact element is going to be removed.

Specified by:

retainAll in interface BooleanCollection

Overrides:

retainAll in class AbstractBooleanCollection

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)

toArray

@Deprecated
public java.lang.Object[] toArray()

Deprecated.

A toArray implementation that ensures the Array itself is a Object.

Specified by:

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

Specified by:

toArray in interface java.util.List<java.lang.Boolean>

Overrides:

toArray in class java.util.AbstractCollection<java.lang.Boolean>

Returns:

a Array of the elements in the list

toArray

@Deprecated
public <E> E[] toArray(E[] a)

Deprecated.

A toArray implementation that ensures the Array itself is a Object.

Specified by:

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

Specified by:

toArray in interface java.util.List<java.lang.Boolean>

Overrides:

toArray in class java.util.AbstractCollection<java.lang.Boolean>

Parameters:

a - original array. If null a Object array with the right size is created. If to small the Array of the same type is created with the right size

Returns:

a Array of the elements in the list

toBooleanArray

public boolean[] toBooleanArray(boolean[] a)

Description copied from class: AbstractBooleanCollection

A Type-Specific implementation of toArray. This implementation iterates over all elements and unwraps them into primitive type.

Specified by:

toBooleanArray in interface BooleanCollection

Overrides:

toBooleanArray in class AbstractBooleanCollection

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[])

size

public int size()

A function to return the size of the list

Specified by:

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

Specified by:

size in interface java.util.List<java.lang.Boolean>

Specified by:

size in interface BooleanStack

Specified by:

size in class java.util.AbstractCollection<java.lang.Boolean>

Returns:

the size of elements in the list

size

public 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

Specified by:

size in interface BooleanList

Overrides:

size in class AbstractBooleanList

Parameters:

size - the requested amount of elements/room for elements

clear

public void clear()

A function to clear all elements in the list.

Specified by:

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

Specified by:

clear in interface java.util.List<java.lang.Boolean>

Specified by:

clear in interface BooleanStack

Overrides:

clear in class java.util.AbstractCollection<java.lang.Boolean>

trim

public boolean trim(int size)

Trims the original collection down to the size of the current elements or the requested size depending which is bigger

Specified by:

trim in interface ITrimmable

Parameters:

size - the requested trim size.

Returns:

if the internal array has been trimmed.

clearAndTrim

public void clearAndTrim(int size)

Trims the collection down to the requested size and clears all elements while doing so

Specified by:

clearAndTrim in interface ITrimmable

Parameters:

size - the amount of elements that should be allowed

Note:

this will enforce minimum size of the collection itself

ensureCapacity

public void ensureCapacity(int size)

Increases the capacity of this implementation instance, if necessary, to ensure that it can hold at least the number of elements specified by the minimum capacity argument.

Specified by:

ensureCapacity in interface IArray

Parameters:

size - the desired minimum capacity

copy

public BooleanArrayList 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

Specified by:

copy in interface BooleanList

Overrides:

copy in class AbstractBooleanList

Returns:

a Shallow Copy of the collection

spliterator

public BooleanSplititerator spliterator()

A Type Specific Type Splititerator to reduce boxing/unboxing

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

spliterator in interface BooleanCollection

Specified by:

spliterator in interface BooleanIterable

Specified by:

spliterator in interface BooleanList

Returns:

type specific splititerator

Note:

characteristics are ordered, sized, subsized