AbstractObjectList (Primitive-Collections 0.7.0 API)

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

Type Parameters:

T - the type 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>

Direct Known Subclasses:

CopyOnWriteObjectArrayList, ImmutableObjectList, ObjectArrayList, ObjectLinkedList
```
public abstract class AbstractObjectList<T>
extends AbstractObjectCollection<T>
implements ObjectList<T>
```
Abstract implementation of the ObjectList interface.

Constructor Summary

Constructors
Constructor and Description

AbstractObjectList()

Constructors
Constructor and Description
`AbstractObjectList()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`add(T e)` A Type-Specific implementation of add function that delegates to `List.add(int, Object)`
`boolean`	`addAll(java.util.Collection<? extends T> c)` Deprecated. Please use the corresponding type-specific function instead.
`boolean`	`addAll(ObjectCollection<T> c)` A Type-Specific implementation that iterates over the elements and adds them.
`boolean`	`addAll(ObjectList<T> c)` A Type-Specific implementation that iterates over the elements and adds them.
`AbstractObjectList<T>`	`copy()` A Function that does a shallow clone of the Collection itself.
`boolean`	`equals(java.lang.Object o)` Compares if the list are the same.
`int`	`hashCode()` Generates the hashcode based on the values stored in the list.
`int`	`indexOf(java.lang.Object o)` The IndexOf implementation iterates over all elements and compares them to the search value.
`ObjectIterator<T>`	`iterator()` Returns a Type-Specific Iterator to reduce (un)boxing
`int`	`lastIndexOf(java.lang.Object o)` The lastIndexOf implementation iterates over all elements and compares them to the search value.
`ObjectListIterator<T>`	`listIterator()` A Type-Specific Iterator of listIterator
`ObjectListIterator<T>`	`listIterator(int index)` A Type-Specific Iterator of listIterator
`void`	`size(int size)` A function to ensure the elements are within the requested size.
`ObjectList<T>`	`subList(int fromIndex, int toIndex)` A Type-Specific List of subList
`boolean`	`swapRemove(T e)` A Highly Optimized remove function that removes the desired element.

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

Methods inherited from class java.util.AbstractCollection
clear, contains, isEmpty, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface speiger.src.collections.objects.lists.ObjectList
addAll, addAll, addElements, addElements, addElements, addIfAbsent, addIfPresent, extractElements, getElements, getElements, removeElements, replaceAll, sort, spliterator, swapRemove, synchronize, synchronize, unmodifiable, unstableSort

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

Methods inherited from interface speiger.src.collections.objects.collections.ObjectIterable
arrayflatMap, asAsync, count, distinct, filter, findFirst, flatMap, forEach, limit, map, matchesAll, matchesAny, matchesNone, peek, pourAsList, pourAsSet, reduce, reduce, sorted

Methods inherited from interface java.util.List
add, addAll, clear, contains, containsAll, get, isEmpty, remove, remove, removeAll, retainAll, set, size, toArray, toArray

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

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - AbstractObjectList
```
public AbstractObjectList()
```
- Method Detail
  - add
```
public boolean add(T e)
```
    A Type-Specific implementation of add function that delegates to List.add(int, Object)
    
    Specified by:
    
    add in interface java.util.Collection<T>
    
    Specified by:
    
    add in interface java.util.List<T>
    
    Overrides:
    
    add in class java.util.AbstractCollection<T>
  - addAll
```
public boolean addAll(ObjectCollection<T> c)
```
    A Type-Specific implementation that iterates over the elements and adds them.
    
    Specified by:
    
    addAll in interface ObjectCollection<T>
    
    Overrides:
    
    addAll in class AbstractObjectCollection<T>
    
    Parameters:
    
    c - the elements that wants to be added
    
    Returns:
    
    true if the list was modified
  - addAll
```
public boolean addAll(ObjectList<T> c)
```
    A Type-Specific implementation that iterates over the elements and adds them.
    
    Specified by:
    
    addAll in interface ObjectList<T>
    
    Parameters:
    
    c - the elements that wants to be added
    
    Returns:
    
    true if the list was modified
  - addAll
```
@Deprecated
public boolean addAll(java.util.Collection<? extends T> c)
```
    Deprecated. Please use the corresponding type-specific function instead.
    
    This default implementation delegates to the corresponding type-specific function.
    
    Specified by:
    
    addAll in interface java.util.Collection<T>
    
    Specified by:
    
    addAll in interface java.util.List<T>
    
    Overrides:
    
    addAll in class java.util.AbstractCollection<T>
  - indexOf
```
public int indexOf(java.lang.Object o)
```
    The IndexOf implementation iterates over all elements and compares them to the search value.
    
    Specified by:
    
    indexOf in interface java.util.List<T>
    
    Parameters:
    
    o - the value that the index is searched for.
    
    Returns:
    
    index of the value that was searched for. -1 if not found
    
    Note:
    
    it is highly suggested not to use this with Primitives because of boxing. But it is still supported because of ObjectComparason that are custom objects and allow to find the contents.
  - lastIndexOf
```
public int lastIndexOf(java.lang.Object o)
```
    The lastIndexOf implementation iterates over all elements and compares them to the search value.
    
    Specified by:
    
    lastIndexOf in interface java.util.List<T>
    
    Parameters:
    
    o - the value that the index is searched for.
    
    Returns:
    
    the last index of the value that was searched for. -1 if not found
    
    Note:
    
    it is highly suggested not to use this with Primitives because of boxing. But it is still supported because of ObjectComparason that are custom objects and allow to find the contents.
  - swapRemove
```
public boolean swapRemove(T e)
```
    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:
    
    e - the element that should be removed
    
    Returns:
    
    true if the element was removed
  - equals
```
public boolean equals(java.lang.Object o)
```
    Compares if the list are the same.
    
    Specified by:
    
    equals in interface java.util.Collection<T>
    
    Specified by:
    
    equals in interface java.util.List<T>
    
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Generates the hashcode based on the values stored in the list.
    
    Specified by:
    
    hashCode in interface java.util.Collection<T>
    
    Specified by:
    
    hashCode in interface java.util.List<T>
    
    Overrides:
    
    hashCode in class java.lang.Object
  - 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>
    
    See Also:
    
    List.subList(int, int)
  - iterator
```
public ObjectIterator<T> iterator()
```
    Description copied from interface: ObjectCollection
    
    Returns a Type-Specific Iterator to reduce (un)boxing
    
    Specified by:
    
    iterator in interface java.lang.Iterable<T>
    
    Specified by:
    
    iterator in interface java.util.Collection<T>
    
    Specified by:
    
    iterator in interface java.util.List<T>
    
    Specified by:
    
    iterator in interface ObjectCollection<T>
    
    Specified by:
    
    iterator in interface ObjectIterable<T>
    
    Specified by:
    
    iterator in class AbstractObjectCollection<T>
    
    Returns:
    
    a iterator of the collection
    
    See Also:
    
    Collection.iterator()
  - listIterator
```
public ObjectListIterator<T> listIterator()
```
    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>
    
    See Also:
    
    List.listIterator()
  - 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>
    
    See Also:
    
    List.listIterator(int)
  - size
```
public void size(int size)
```
    Description copied from interface: ObjectList
    
    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>
    
    Parameters:
    
    size - the requested amount of elements/room for elements
  - copy
```
public AbstractObjectList<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 AbstractObjectCollection<T>
    
    Returns:
    
    a Shallow Copy of the collection

Class AbstractObjectList<T>

Constructor Summary

Method Summary

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.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 java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

AbstractObjectList

Method Detail

add

addAll

addAll

addAll

indexOf

lastIndexOf

swapRemove

equals

hashCode

subList

iterator

listIterator

listIterator

size

copy