it.unimi.dsi.fastutil.objects

Interface ReferenceList<K>

All Superinterfaces:

java.util.Collection<K>, java.lang.Iterable<K>, java.util.List<K>, ObjectIterable<K>, ReferenceCollection<K>

All Known Implementing Classes:

AbstractReferenceList, AbstractReferenceList.ReferenceSubList, ReferenceArrayList, ReferenceLists.EmptyList, ReferenceLists.Singleton, ReferenceLists.SynchronizedList, ReferenceLists.SynchronizedRandomAccessList, ReferenceLists.UnmodifiableList, ReferenceLists.UnmodifiableRandomAccessList

public interface ReferenceList<K>
extends java.util.List<K>, ReferenceCollection<K>

A type-specific List; provides some additional methods that use polymorphism to avoid (un)boxing.

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

Modifier and Type	Method and Description
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.
void	removeElements(int from, int to) Removes (hopefully quickly) elements of this type-specific list.
void	size(int size) Sets the size of this list.
ReferenceList<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.

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, sort, spliterator, toArray, toArray

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.

Note that this specification strengthens the one given in List.iterator(). It would not be normally necessary, but Iterable.iterator() is bizarrily re-specified in 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 ObjectIterable<K>

Specified by:

iterator in interface ReferenceCollection<K>

Returns:

an iterator on the elements of this list.

See Also:

Iterable.iterator()

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

ReferenceList<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.

Note that this specification strengthens the one given in List.subList(int,int).

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.