CopyOnWriteObjectArrayList (Primitive-Collections 0.8.0 API)

java.lang.Object
- java.util.AbstractCollection<T>
- - speiger.src.collections.objects.collections.AbstractObjectCollection<T>
  - - speiger.src.collections.objects.lists.AbstractObjectList<T>
    - - speiger.src.collections.objects.lists.CopyOnWriteObjectArrayList<T>

Type Parameters:

T - the keyType of elements maintained by this Collection

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>, ObjectCollection<T>, ObjectIterable<T>, ObjectList<T>, ISizeProvider, ITrimmable, Stack<T>
```
public class CopyOnWriteObjectArrayList<T>
extends AbstractObjectList<T>
implements ITrimmable, Stack<T>
```
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 ITrimmable, Stack and with optimized functions that use type-specific implementations for primitives and optimized logic for bulkactions.

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

Constructor Summary

Constructors
Constructor and Description
`CopyOnWriteObjectArrayList()` Creates a new ArrayList with a Empty array.
`CopyOnWriteObjectArrayList(java.util.Collection<? extends T> c)` Deprecated.
`CopyOnWriteObjectArrayList(ObjectCollection<T> c)` Creates a new ArrayList a copy with the contents of the Collection.
`CopyOnWriteObjectArrayList(ObjectList<T> l)` Creates a new ArrayList a copy with the contents of the List.
`CopyOnWriteObjectArrayList(T... a)` Creates a new ArrayList with a Copy of the array
`CopyOnWriteObjectArrayList(T[] a, int length)` Creates a new ArrayList with a Copy of the array with a custom length
`CopyOnWriteObjectArrayList(T[] a, int offset, int length)` Creates a new ArrayList with a Copy of the array with in the custom range.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`add(int index, T e)` Appends the specified element to the index of the list
`boolean`	`add(T e)` Appends the specified element to the end of this list.
`boolean`	`addAll(int index, java.util.Collection<? extends T> c)` Deprecated.
`boolean`	`addAll(int index, ObjectCollection<T> c)` Appends the specified elements to the index of the list.
`boolean`	`addAll(int index, ObjectList<T> c)` Appends the specified elements to the index of the list.
`boolean`	`addAll(T[] e, int offset, int length)` A Type-Specific Array based addAll method to reduce the amount of Wrapping
`void`	`addElements(int from, T[] 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(java.lang.Object o)` Deprecated.
`CopyOnWriteObjectArrayList<T>`	`copy()` A Function that does a shallow clone of the Collection itself.
`int`	`count(java.util.function.Predicate<T> filter)` Helper function to reduce stream usage that allows to count the valid elements.
`<K> K[]`	`extractElements(int from, int to, java.lang.Class<K> type)` A function to fast extract elements out of the list, this removes the elements that were fetched.
`T`	`findFirst(java.util.function.Predicate<T> filter)` Helper function to reduce stream usage that allows to filter for the first match.
`void`	`forEach(java.util.function.Consumer<? super T> action)` A Type Specific foreach function that reduces (un)boxing
`<E> void`	`forEach(E input, ObjectObjectConsumer<E,T> action)` Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
`T`	`get(int index)` A Type-Specific get function to reduce (un)boxing
`T[]`	`getElements(int from, T[] a, int offset, int length)` A function to fast fetch elements from the list
`int`	`indexOf(java.lang.Object o)` Deprecated.
`int`	`lastIndexOf(java.lang.Object o)` Deprecated.
`ObjectListIterator<T>`	`listIterator(int index)` A Type-Specific Iterator of listIterator
`boolean`	`matchesAll(java.util.function.Predicate<T> filter)` Helper function to reduce stream usage that allows to filter for all matches.
`boolean`	`matchesAny(java.util.function.Predicate<T> filter)` Helper function to reduce stream usage that allows to filter for any matches.
`boolean`	`matchesNone(java.util.function.Predicate<T> filter)` Helper function to reduce stream usage that allows to filter for no matches.
`static <T> CopyOnWriteObjectArrayList<T>`	`of(java.lang.Class<T> c)` Creates a new ArrayList with a EmptyObject array of the Type requested
`T`	`peek(int index)` Provides the Selected Object from the stack.
`T`	`pop()` A Type-Specific pop function to reduce (un)boxing
`void`	`push(T e)` Appends the specified element to the end of this Stack.
`<E> E`	`reduce(E identity, java.util.function.BiFunction<E,T,E> operator)` Performs a reduction on the elements of this Iterable
`T`	`reduce(ObjectObjectUnaryOperator<T,T> operator)` Performs a reduction on the elements of this Iterable
`T`	`remove(int index)` A Type-Specific remove function to reduce (un)boxing
`boolean`	`remove(java.lang.Object type)`
`boolean`	`removeAll(java.util.Collection<?> c)` Deprecated.
`boolean`	`removeAll(ObjectCollection<T> c)` A function to remove all elements that were provided in the other collection
`boolean`	`removeAll(ObjectCollection<T> c, java.util.function.Consumer<T> r)` A Type-Specific removeAll function that reduces (un)boxing.
`void`	`removeElements(int from, int to)` a function to fast remove elements from the list.
`boolean`	`removeIf(java.util.function.Predicate<? super T> filter)` Deprecated.
`void`	`replaceAll(java.util.function.UnaryOperator<T> o)` A function to replace all values in the list
`boolean`	`retainAll(java.util.Collection<?> c)` Deprecated.
`boolean`	`retainAll(ObjectCollection<T> 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(ObjectCollection<T> c, java.util.function.Consumer<T> r)` A Type-Specific retainAll function that reduces (un)boxing.
`T`	`set(int index, T 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(java.util.Comparator<? super T> c)` Sorts the elements specified by the Natural order either by using the Comparator or the elements
`ObjectSplititerator<T>`	`spliterator()` A Type Specific Type Splititerator to reduce boxing/unboxing
`ObjectList<T>`	`subList(int fromIndex, int toIndex)` A Type-Specific List of subList
`T`	`swapRemove(int index)` A Highly Optimized remove function that removes the desired element.
`java.lang.Object[]`	`toArray()` A toArray implementation that ensures the Array itself is a Object.
`<E> E[]`	`toArray(E[] a)` A toArray implementation that ensures the Array itself is a Object.
`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(java.util.Comparator<? super T> c)` Sorts the elements specified by the Natural order either by using the Comparator or the elements using a unstable sort

Methods inherited from class speiger.src.collections.objects.lists.AbstractObjectList
addAll, addAll, addAll, equals, hashCode, iterator, listIterator, swapRemove

Methods inherited from class speiger.src.collections.objects.collections.AbstractObjectCollection
containsAll, containsAll, containsAny, containsAny

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.utils.ITrimmable
clearAndTrim, trim

Methods inherited from interface speiger.src.collections.utils.Stack
isEmpty, top

Methods inherited from interface speiger.src.collections.objects.lists.ObjectList
addElements, addElements, addIfAbsent, addIfPresent, forEachIndexed, getElements, synchronize, synchronize, unmodifiable

Methods inherited from interface speiger.src.collections.objects.collections.ObjectCollection
addAll, addAll, containsAll, containsAny, containsAny, pour, toArray

Methods inherited from interface speiger.src.collections.objects.collections.ObjectIterable
arrayflatMap, asAsync, distinct, filter, flatMap, limit, map, peek, pourAsList, pourAsSet, repeat, sorted

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

Methods inherited from interface java.util.List
containsAll, isEmpty

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

- Constructor Detail
  - CopyOnWriteObjectArrayList
```
public CopyOnWriteObjectArrayList()
```
    Creates a new ArrayList with a Empty array.
  - CopyOnWriteObjectArrayList
```
@Deprecated
public CopyOnWriteObjectArrayList(java.util.Collection<? extends T> 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
  - CopyOnWriteObjectArrayList
```
public CopyOnWriteObjectArrayList(ObjectCollection<T> c)
```
    Creates a new ArrayList a copy with the contents of the Collection.
    
    Parameters:
    
    c - the elements that should be added into the list
  - CopyOnWriteObjectArrayList
```
public CopyOnWriteObjectArrayList(ObjectList<T> l)
```
    Creates a new ArrayList a copy with the contents of the List.
    
    Parameters:
    
    l - the elements that should be added into the list
  - CopyOnWriteObjectArrayList
```
public CopyOnWriteObjectArrayList(T... a)
```
    Creates a new ArrayList with a Copy of the array
    
    Parameters:
    
    a - the array that should be copied
  - CopyOnWriteObjectArrayList
```
public CopyOnWriteObjectArrayList(T[] 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
  - CopyOnWriteObjectArrayList
```
public CopyOnWriteObjectArrayList(T[] 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
  - of
```
public static <T> CopyOnWriteObjectArrayList<T> of(java.lang.Class<T> c)
```
    Creates a new ArrayList with a EmptyObject array of the Type requested
    
    Type Parameters:
    
    T - the keyType of elements maintained by this Collection
    
    Parameters:
    
    c - the type of the array
    
    Returns:
    
    a typed List
  - add
```
public boolean add(T e)
```
    Appends the specified element to the end of this list.
    
    Specified by:
    
    add in interface java.util.Collection<T>
    
    Specified by:
    
    add in interface java.util.List<T>
    
    Overrides:
    
    add in class AbstractObjectList<T>
    
    Parameters:
    
    e - element to be appended to this list
    
    Returns:
    
    true (as specified by Collection.add(E))
  - push
```
public void push(T e)
```
    Appends the specified element to the end of this Stack.
    
    Specified by:
    
    push in interface Stack<T>
    
    Parameters:
    
    e - element to be appended to this Stack
  - add
```
public void add(int index,
                T e)
```
    Appends the specified element to the index of the list
    
    Specified by:
    
    add in interface java.util.List<T>
    
    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
  - addAll
```
@Deprecated
public boolean addAll(int index,
                                   java.util.Collection<? extends T> 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<T>
    
    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,
                      ObjectCollection<T> 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 ObjectList<T>
    
    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,
                      ObjectList<T> c)
```
    Appends the specified elements to the index of the list.
    
    Specified by:
    
    addAll in interface ObjectList<T>
    
    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(T[] e,
                      int offset,
                      int length)
```
    Description copied from interface: ObjectCollection
    
    A Type-Specific Array based addAll method to reduce the amount of Wrapping
    
    Specified by:
    
    addAll in interface ObjectCollection<T>
    
    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,
                        T[] a,
                        int offset,
                        int length)
```
    Appends the specified array elements to the index of the list.
    
    Specified by:
    
    addElements in interface ObjectList<T>
    
    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 T[] getElements(int from,
                       T[] a,
                       int offset,
                       int length)
```
    A function to fast fetch elements from the list
    
    Specified by:
    
    getElements in interface ObjectList<T>
    
    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 ObjectList<T>
    
    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 <K> K[] extractElements(int from,
                               int to,
                               java.lang.Class<K> type)
```
    A function to fast extract elements out of the list, this removes the elements that were fetched.
    
    Specified by:
    
    extractElements in interface ObjectList<T>
    
    Type Parameters:
    
    K - the keyType of elements maintained by this Collection
    
    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)
    
    type - the type of the OutputArray
    
    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<T>
    
    Specified by:
    
    contains in interface java.util.List<T>
    
    Overrides:
    
    contains in class java.util.AbstractCollection<T>
    
    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<T>
    
    Overrides:
    
    indexOf in class AbstractObjectList<T>
    
    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<T>
    
    Overrides:
    
    lastIndexOf in class AbstractObjectList<T>
    
    Parameters:
    
    o - the element that is searched for
    
    Returns:
    
    the last index of the element if found. (if not found then -1)
  - sort
```
public void sort(java.util.Comparator<? super T> c)
```
    Sorts the elements specified by the Natural order either by using the Comparator or the elements
    
    Specified by:
    
    sort in interface java.util.List<T>
    
    Specified by:
    
    sort in interface ObjectList<T>
    
    Parameters:
    
    c - the sorter of the elements, can be null
    
    See Also:
    
    List.sort(Comparator)
  - unstableSort
```
public void unstableSort(java.util.Comparator<? super T> 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 ObjectList<T>
    
    Parameters:
    
    c - the sorter of the elements, can be null
    
    See Also:
    
    List.sort(Comparator)
  - get
```
public T get(int index)
```
    A Type-Specific get function to reduce (un)boxing
    
    Specified by:
    
    get in interface java.util.List<T>
    
    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
  - peek
```
public T peek(int index)
```
    Provides the Selected Object from the stack. Top to bottom
    
    Specified by:
    
    peek in interface Stack<T>
    
    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)
  - listIterator
```
public ObjectListIterator<T> listIterator(int index)
```
    Description copied from interface: ObjectList
    
    A Type-Specific Iterator of listIterator
    
    Specified by:
    
    listIterator in interface java.util.List<T>
    
    Specified by:
    
    listIterator in interface ObjectList<T>
    
    Overrides:
    
    listIterator in class AbstractObjectList<T>
    
    See Also:
    
    List.listIterator(int)
  - subList
```
public ObjectList<T> subList(int fromIndex,
                             int toIndex)
```
    Description copied from interface: ObjectList
    
    A Type-Specific List of subList
    
    Specified by:
    
    subList in interface java.util.List<T>
    
    Specified by:
    
    subList in interface ObjectList<T>
    
    Overrides:
    
    subList in class AbstractObjectList<T>
    
    See Also:
    
    List.subList(int, int)
  - forEach
```
public void forEach(java.util.function.Consumer<? super T> action)
```
    A Type Specific foreach function that reduces (un)boxing
    Specified by:
    
    forEach in interface java.lang.Iterable<T>
    
    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,m=data.length;i<m;i++) action.accept(data[i]);
  - forEach
```
public <E> void forEach(E input,
                        ObjectObjectConsumer<E,T> action)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce Lambda usage and allow for more method references, since these are faster/cleaner.
    
    Specified by:
    
    forEach in interface ObjectIterable<T>
    
    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(java.util.function.Predicate<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for any matches.
    
    Specified by:
    
    matchesAny in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if any matches were found
  - matchesNone
```
public boolean matchesNone(java.util.function.Predicate<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for no matches.
    
    Specified by:
    
    matchesNone in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if no matches were found
  - matchesAll
```
public boolean matchesAll(java.util.function.Predicate<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for all matches.
    
    Specified by:
    
    matchesAll in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    true if all matches.
  - findFirst
```
public T findFirst(java.util.function.Predicate<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to filter for the first match.
    
    Specified by:
    
    findFirst in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the found value or the null equivalent variant.
  - reduce
```
public <E> E reduce(E identity,
                    java.util.function.BiFunction<E,T,E> operator)
```
    Description copied from interface: ObjectIterable
    
    Performs a reduction on the elements of this Iterable
    
    Specified by:
    
    reduce in interface ObjectIterable<T>
    
    Type Parameters:
    
    E - the keyType of elements maintained by this Collection
    
    Parameters:
    
    identity - the start value
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns identity if nothing was found
  - reduce
```
public T reduce(ObjectObjectUnaryOperator<T,T> operator)
```
    Description copied from interface: ObjectIterable
    
    Performs a reduction on the elements of this Iterable
    
    Specified by:
    
    reduce in interface ObjectIterable<T>
    
    Parameters:
    
    operator - the operation that should be applied
    
    Returns:
    
    the reduction result, returns null value if nothing was found
  - count
```
public int count(java.util.function.Predicate<T> filter)
```
    Description copied from interface: ObjectIterable
    
    Helper function to reduce stream usage that allows to count the valid elements.
    
    Specified by:
    
    count in interface ObjectIterable<T>
    
    Parameters:
    
    filter - that should be applied
    
    Returns:
    
    the amount of Valid Elements
  - set
```
public T set(int index,
             T e)
```
    A Type-Specific set function to reduce (un)boxing
    
    Specified by:
    
    set in interface java.util.List<T>
    
    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
  - replaceAll
```
public void replaceAll(java.util.function.UnaryOperator<T> o)
```
    A function to replace all values in the list
    
    Specified by:
    
    replaceAll in interface java.util.List<T>
    
    Specified by:
    
    replaceAll in interface ObjectList<T>
    
    Parameters:
    
    o - the action to replace the values
    
    Throws:
    
    java.lang.NullPointerException - if o is null
  - remove
```
public T remove(int index)
```
    A Type-Specific remove function to reduce (un)boxing
    
    Specified by:
    
    remove in interface java.util.List<T>
    
    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
  - swapRemove
```
public T swapRemove(int index)
```
    Description copied from interface: ObjectList
    
    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 ObjectList<T>
    
    Parameters:
    
    index - the index of the element to be removed
    
    Returns:
    
    the element previously at the specified position
  - remove
```
public boolean remove(java.lang.Object type)
```
    Specified by:
    
    remove in interface java.util.Collection<T>
    
    Specified by:
    
    remove in interface java.util.List<T>
    
    Overrides:
    
    remove in class java.util.AbstractCollection<T>
  - pop
```
public T pop()
```
    A Type-Specific pop function to reduce (un)boxing
    
    Specified by:
    
    pop in interface Stack<T>
    
    Returns:
    
    the value of the requested index
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - if the index is out of range
  - 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<T>
    
    Specified by:
    
    removeAll in interface java.util.List<T>
    
    Overrides:
    
    removeAll in class java.util.AbstractCollection<T>
    
    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<T>
    
    Specified by:
    
    retainAll in interface java.util.List<T>
    
    Overrides:
    
    retainAll in class java.util.AbstractCollection<T>
    
    Parameters:
    
    c - the elements that should be kept. If empty, LongArrayList#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 T> 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<T>
    
    Parameters:
    
    filter - the filter to remove elements
    
    Returns:
    
    true if the list was modified
  - removeAll
```
public boolean removeAll(ObjectCollection<T> c)
```
    A function to remove all elements that were provided in the other collection
    
    Specified by:
    
    removeAll in interface ObjectCollection<T>
    
    Overrides:
    
    removeAll in class AbstractObjectCollection<T>
    
    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(ObjectCollection<T> c,
                         java.util.function.Consumer<T> r)
```
    Description copied from interface: ObjectCollection
    
    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 ObjectCollection<T>
    
    Overrides:
    
    removeAll in class AbstractObjectCollection<T>
    
    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(ObjectCollection<T> 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 ObjectCollection<T>
    
    Overrides:
    
    retainAll in class AbstractObjectCollection<T>
    
    Parameters:
    
    c - the elements that should be kept. If empty, LongArrayList#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(ObjectCollection<T> c,
                         java.util.function.Consumer<T> r)
```
    Description copied from interface: ObjectCollection
    
    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 ObjectCollection<T>
    
    Overrides:
    
    retainAll in class AbstractObjectCollection<T>
    
    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
```
public java.lang.Object[] toArray()
```
    A toArray implementation that ensures the Array itself is a Object.
    
    Specified by:
    
    toArray in interface java.util.Collection<T>
    
    Specified by:
    
    toArray in interface java.util.List<T>
    
    Overrides:
    
    toArray in class java.util.AbstractCollection<T>
    
    Returns:
    
    a Array of the elements in the list
  - toArray
```
public <E> E[] toArray(E[] a)
```
    A toArray implementation that ensures the Array itself is a Object.
    
    Specified by:
    
    toArray in interface java.util.Collection<T>
    
    Specified by:
    
    toArray in interface java.util.List<T>
    
    Overrides:
    
    toArray in class java.util.AbstractCollection<T>
    
    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
  - size
```
public int size()
```
    A function to return the size of the list
    
    Specified by:
    
    size in interface java.util.Collection<T>
    
    Specified by:
    
    size in interface java.util.List<T>
    
    Specified by:
    
    size in interface ISizeProvider
    
    Specified by:
    
    size in interface Stack<T>
    
    Specified by:
    
    size in class java.util.AbstractCollection<T>
    
    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 ObjectList<T>
    
    Overrides:
    
    size in class AbstractObjectList<T>
    
    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<T>
    
    Specified by:
    
    clear in interface java.util.List<T>
    
    Specified by:
    
    clear in interface Stack<T>
    
    Overrides:
    
    clear in class java.util.AbstractCollection<T>
  - 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
  - copy
```
public CopyOnWriteObjectArrayList<T> copy()
```
    Description copied from interface: ObjectCollection
    
    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 ObjectCollection<T>
    
    Specified by:
    
    copy in interface ObjectList<T>
    
    Overrides:
    
    copy in class AbstractObjectList<T>
    
    Returns:
    
    a Shallow Copy of the collection
  - spliterator
```
public ObjectSplititerator<T> spliterator()
```
    A Type Specific Type Splititerator to reduce boxing/unboxing
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<T>
    
    Specified by:
    
    spliterator in interface java.util.Collection<T>
    
    Specified by:
    
    spliterator in interface java.util.List<T>
    
    Specified by:
    
    spliterator in interface ObjectCollection<T>
    
    Specified by:
    
    spliterator in interface ObjectIterable<T>
    
    Specified by:
    
    spliterator in interface ObjectList<T>
    
    Returns:
    
    type specific splititerator
    
    Note:
    
    characteristics are ordered, sized, subsized

Class CopyOnWriteObjectArrayList<T>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class speiger.src.collections.objects.lists.AbstractObjectList

Methods inherited from class speiger.src.collections.objects.collections.AbstractObjectCollection

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface speiger.src.collections.objects.lists.ObjectList

Methods inherited from interface speiger.src.collections.objects.collections.ObjectCollection

Methods inherited from interface speiger.src.collections.objects.collections.ObjectIterable

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

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Constructor Detail

CopyOnWriteObjectArrayList

CopyOnWriteObjectArrayList

CopyOnWriteObjectArrayList

CopyOnWriteObjectArrayList

CopyOnWriteObjectArrayList

CopyOnWriteObjectArrayList

CopyOnWriteObjectArrayList

Method Detail

of

add

push

add

addAll

addAll

addAll

addAll

addElements

getElements

removeElements

extractElements

contains

indexOf

lastIndexOf

sort

unstableSort

get

peek

listIterator

subList

forEach

forEach

matchesAny

matchesNone

matchesAll

findFirst

reduce

reduce

count

set

replaceAll

remove

swapRemove

remove

pop

removeAll

retainAll

removeIf

removeAll

removeAll

retainAll

retainAll

toArray

toArray

size

size

clear

trim

clearAndTrim

copy

spliterator