ObjectList (object-common 8.5.13-SNAPSHOT API)

All Superinterfaces:

java.util.Collection<K>, java.lang.Comparable<java.util.List<? extends K>>, java.lang.Iterable<K>, java.util.List<K>, ObjectCollection<K>, ObjectIterable<K>

All Known Implementing Classes:

AbstractObjectList, AbstractObjectList.ObjectRandomAccessSubList, AbstractObjectList.ObjectSubList, ObjectArrayList, ObjectImmutableList, ObjectLists.EmptyList, ObjectLists.Singleton, ObjectLists.SynchronizedList, ObjectLists.SynchronizedRandomAccessList, ObjectLists.UnmodifiableList, ObjectLists.UnmodifiableRandomAccessList
```
public interface ObjectList<K>
extends java.util.List<K>, java.lang.Comparable<java.util.List<? extends K>>, ObjectCollection<K>
```
A type-specific List; provides some additional methods that use polymorphism to avoid (un)boxing.
Note that this type-specific interface extends Comparable: it is expected that implementing classes perform a lexicographical comparison using the standard operator "less then" for primitive types, and the usual compareTo() method for objects.
Additionally, this interface strengthens iterator(), listIterator(), listIterator(int) and subList(int,int). The former had been already strengthened upstream, but unfortunately List re-specifies it.
Besides polymorphic methods, this interfaces specifies methods to copy into an array or remove contiguous sublists. Although the abstract implementation of this interface provides simple, one-by-one implementations of these methods, it is expected that concrete implementation override them with optimized versions.

See Also:

List

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`addAll(int index, ObjectList<? extends K> l)` Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).
`default boolean`	`addAll(ObjectList<? extends K> l)` Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).
`void`	`addElements(int index, K[] a)` Add (hopefully quickly) elements to this type-specific list.
`void`	`addElements(int index, K[] a, int offset, int length)` Add (hopefully quickly) elements to this type-specific list.
`void`	`getElements(int from, java.lang.Object[] a, int offset, int length)` Copies (hopefully quickly) elements of this type-specific list into the given array.
`ObjectListIterator<K>`	`iterator()` Returns a type-specific iterator on the elements of this list.
`ObjectListIterator<K>`	`listIterator()` Returns a type-specific list iterator on the list.
`ObjectListIterator<K>`	`listIterator(int index)` Returns a type-specific list iterator on the list starting at a given index.
`static <K> ObjectList<K>`	`of()` Returns an immutable empty list.
`static <K> ObjectList<K>`	`of(K... a)` Returns an immutable list with the elements given.
`static <K> ObjectList<K>`	`of(K e)` Returns an immutable list with the element given.
`static <K> ObjectList<K>`	`of(K e0, K e1)` Returns an immutable list with the elements given.
`static <K> ObjectList<K>`	`of(K e0, K e1, K e2)` Returns an immutable list with the elements given.
`void`	`removeElements(int from, int to)` Removes (hopefully quickly) elements of this type-specific list.
`default void`	`setElements(int index, K[] a)` Set (hopefully quickly) elements to match the array given.
`default void`	`setElements(int index, K[] a, int offset, int length)` Set (hopefully quickly) elements to match the array given.
`default void`	`setElements(K[] a)` Set (hopefully quickly) elements to match the array given.
`void`	`size(int size)` Sets the size of this list.
`default void`	`sort(java.util.Comparator<? super K> comparator)` Sorts this list using a sort assured to be stable.
`default it.unimi.dsi.fastutil.objects.ObjectSpliterator<K>`	`spliterator()` Returns a type-specific spliterator on the elements of this list.
`ObjectList<K>`	`subList(int from, int to)` Returns a type-specific view of the portion of this list from the index `from`, inclusive, to the index `to`, exclusive.
`default void`	`unstableSort(java.util.Comparator<? super K> comparator)` Sorts this list using a sort not assured to be stable.

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

Methods inherited from interface java.lang.Comparable
compareTo

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

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - iterator
```
ObjectListIterator<K> iterator()
```
    Returns a type-specific iterator on the elements of this list.
    
    Specified by:
    
    iterator in interface java.util.Collection<K>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<K>
    
    Specified by:
    
    iterator in interface java.util.List<K>
    
    Specified by:
    
    iterator in interface ObjectCollection<K>
    
    Specified by:
    
    iterator in interface ObjectIterable<K>
    
    Returns:
    
    an iterator on the elements of this list.
    
    See Also:
    
    Iterable.iterator()
  - spliterator
```
default it.unimi.dsi.fastutil.objects.ObjectSpliterator<K> spliterator()
```
    Returns a type-specific spliterator on the elements of this list.
    List spliterators must report at least Spliterator.SIZED and Spliterator.ORDERED.
    See List.spliterator() for more documentation on the requirements of the returned spliterator.
    
    Specified by:
    
    spliterator in interface java.util.Collection<K>
    
    Specified by:
    
    spliterator in interface java.lang.Iterable<K>
    
    Specified by:
    
    spliterator in interface java.util.List<K>
    
    Specified by:
    
    spliterator in interface ObjectCollection<K>
    
    Specified by:
    
    spliterator in interface ObjectIterable<K>
    
    Returns:
    
    a type-specific spliterator on the elements of this collection.
    
    Since:
    
    8.5.0
  - listIterator
```
ObjectListIterator<K> listIterator()
```
    Returns a type-specific list iterator on the list.
    
    Specified by:
    
    listIterator in interface java.util.List<K>
    
    See Also:
    
    List.listIterator()
  - listIterator
```
ObjectListIterator<K> listIterator(int index)
```
    Returns a type-specific list iterator on the list starting at a given index.
    
    Specified by:
    
    listIterator in interface java.util.List<K>
    
    See Also:
    
    List.listIterator(int)
  - subList
```
ObjectList<K> subList(int from,
                      int to)
```
    Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.
    
    Specified by:
    
    subList in interface java.util.List<K>
    
    See Also:
    
    List.subList(int,int)
  - size
```
void size(int size)
```
    Sets the size of this list.
    If the specified size is smaller than the current size, the last elements are discarded. Otherwise, they are filled with 0/null/false.
    
    Parameters:
    
    size - the new size.
  - getElements
```
void getElements(int from,
                 java.lang.Object[] a,
                 int offset,
                 int length)
```
    Copies (hopefully quickly) elements of this type-specific list into the given array.
    
    Parameters:
    
    from - the start index (inclusive).
    
    a - the destination array.
    
    offset - the offset into the destination array where to store the first element copied.
    
    length - the number of elements to be copied.
  - removeElements
```
void removeElements(int from,
                    int to)
```
    Removes (hopefully quickly) elements of this type-specific list.
    
    Parameters:
    
    from - the start index (inclusive).
    
    to - the end index (exclusive).
  - addElements
```
void addElements(int index,
                 K[] a)
```
    Add (hopefully quickly) elements to this type-specific list.
    
    Parameters:
    
    index - the index at which to add elements.
    
    a - the array containing the elements.
  - addElements
```
void addElements(int index,
                 K[] a,
                 int offset,
                 int length)
```
    Add (hopefully quickly) elements to this type-specific list.
    
    Parameters:
    
    index - the index at which to add elements.
    
    a - the array containing the elements.
    
    offset - the offset of the first element to add.
    
    length - the number of elements to add.
  - setElements
```
default void setElements(K[] a)
```
    Set (hopefully quickly) elements to match the array given.
    
    Parameters:
    
    a - the array containing the elements.
    
    Since:
    
    8.3.0
  - setElements
```
default void setElements(int index,
                         K[] a)
```
    Set (hopefully quickly) elements to match the array given.
    
    Parameters:
    
    index - the index at which to start setting elements.
    
    a - the array containing the elements.
    
    Since:
    
    8.3.0
  - setElements
```
default void setElements(int index,
                         K[] a,
                         int offset,
                         int length)
```
    Set (hopefully quickly) elements to match the array given. Sets each in this list to the corresponding elements in the array, as if by
```
 ListIterator iter = listIterator(index);
 int i = 0;
 while (i < length) {
   iter.next();
   iter.set(a[offset + i++]);
 }
 
```
    However, the exact implementation may be more efficient, taking into account whether random access is faster or not, or at the discretion of subclasses, abuse internals.
    Parameters:
    
    index - the index at which to start setting elements.
    
    a - the array containing the elements
    
    offset - the offset of the first element to add.
    
    length - the number of elements to add.
    
    Since:
    
    8.3.0
  - addAll
```
default boolean addAll(int index,
                       ObjectList<? extends K> l)
```
    Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).
    
    See Also:
    
    List.addAll(int,Collection)
  - addAll
```
default boolean addAll(ObjectList<? extends K> l)
```
    Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).
    
    See Also:
    
    List.addAll(Collection)
  - of
```
static <K> ObjectList<K> of()
```
    Returns an immutable empty list.
    
    Returns:
    
    an immutable empty list.
  - of
```
static <K> ObjectList<K> of(K e)
```
    Returns an immutable list with the element given.
    
    Parameters:
    
    e - the element that the returned list will contain.
    
    Returns:
    
    an immutable list containing e.
  - of
```
static <K> ObjectList<K> of(K e0,
                            K e1)
```
    Returns an immutable list with the elements given.
    
    Parameters:
    
    e0 - the first element.
    
    e1 - the second element.
    
    Returns:
    
    an immutable list containing e0 and e1.
  - of
```
static <K> ObjectList<K> of(K e0,
                            K e1,
                            K e2)
```
    Returns an immutable list with the elements given.
    
    Parameters:
    
    e0 - the first element.
    
    e1 - the second element.
    
    e2 - the third element.
    
    Returns:
    
    an immutable list containing e0, e1, and e2.
  - of
```
@SafeVarargs
static <K> ObjectList<K> of(K... a)
```
    Returns an immutable list with the elements given.
    Note that this method does not perform a defensive copy.
    
    Parameters:
    
    a - a list of elements that will be used to initialize the immutable list.
    
    Returns:
    
    an immutable list containing the elements of a.
  - sort
```
default void sort(java.util.Comparator<? super K> comparator)
```
    Sorts this list using a sort assured to be stable.
    Pass null to sort using natural ordering.
    Unless a subclass specifies otherwise, the results of the method if the list is concurrently modified during the sort are unspecified.
    
    Specified by:
    
    sort in interface java.util.List<K>
    
    Since:
    
    8.5.0
  - unstableSort
```
default void unstableSort(java.util.Comparator<? super K> comparator)
```
    Sorts this list using a sort not assured to be stable. This differs from List.sort(java.util.Comparator) in that the results are not assured to be stable, but may be a bit faster.
    Pass null to sort using natural ordering.
    Unless a subclass specifies otherwise, the results of the method if the list is concurrently modified during the sort are unspecified.
    
    Since:
    
    8.3.0

Interface ObjectList<K>

Method Summary

Methods inherited from interface java.util.List

Methods inherited from interface java.lang.Comparable

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Method Detail

iterator

spliterator

listIterator

listIterator

subList

size

getElements

removeElements

addElements

addElements

setElements

setElements

setElements

addAll

addAll

of

of

of

of

of

sort

unstableSort