Package org.codelibs.jhighlight.fastutil.objects

Interface ObjectList<K>

All Superinterfaces:

Collection<K>, Comparable<List<? extends K>>, Iterable<K>, List<K>, ObjectCollection<K>, ObjectIterable<K>

All Known Implementing Classes:

AbstractObjectList, AbstractObjectList.ObjectSubList, ObjectArrayList

public interface ObjectList<K>
extends List<K>, Comparable<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 listIterator(), listIterator(int) and subList(int,int).

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	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, 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 (in proper sequence).
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.
ObjectListIterator<K>	objectListIterator()	Deprecated. As of fastutil 5, replaced by listIterator().
ObjectListIterator<K>	objectListIterator(int index)	Deprecated. As of fastutil 5, replaced by listIterator(int).
ObjectList<K>	objectSubList(int from, int to)	Deprecated. As of fastutil 5, replaced by subList(int,int).
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.
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.

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface java.lang.Iterable

forEach

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 org.codelibs.jhighlight.fastutil.objects.ObjectCollection

objectIterator, toArray

Method Detail

iterator

ObjectListIterator<K> iterator()

Returns a type-specific iterator on the elements of this list (in proper sequence). 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 Collection<K>

Specified by:

iterator in interface Iterable<K>

Specified by:

iterator in interface 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 (in proper sequence).

objectListIterator

@Deprecated
ObjectListIterator<K> objectListIterator()

Deprecated.

As of fastutil 5, replaced by listIterator().

Returns a type-specific list iterator on the list.

See Also:

listIterator()

objectListIterator

@Deprecated
ObjectListIterator<K> objectListIterator(int index)

Deprecated.

As of fastutil 5, replaced by listIterator(int).

Returns a type-specific list iterator on the list starting at a given index.

See Also:

listIterator(int)

listIterator

ObjectListIterator<K> listIterator()

Returns a type-specific list iterator on the list.

Specified by:

listIterator in interface 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 List<K>

See Also:

List.listIterator(int)

objectSubList

@Deprecated
ObjectList<K> objectSubList(int from,
                            int to)

Deprecated.

As of fastutil 5, replaced by subList(int,int).

Returns a type-specific view of the portion of this list from the index from, inclusive, to the index to, exclusive.

See Also:

List.subList(int,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.

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

Specified by:

subList in interface 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,
                 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.