Package it.unimi.dsi.fastutil.objects

Class AbstractObjectList<K>

java.lang.Object

java.util.AbstractCollection<K>

it.unimi.dsi.fastutil.objects.AbstractObjectCollection<K>

it.unimi.dsi.fastutil.objects.AbstractObjectList<K>

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractObjectList.ObjectSubList, ByteArrayFrontCodedList, CharArrayFrontCodedList, IntArrayFrontCodedList, LongArrayFrontCodedList, ObjectArrayList, ObjectImmutableList, ObjectLists.Singleton, ShortArrayFrontCodedList

public abstract class AbstractObjectList<K>
extends AbstractObjectCollection<K>
implements ObjectList<K>, Stack<K>

An abstract class providing basic methods for lists implementing a type-specific list interface.

As an additional bonus, this class implements on top of the list operations a type-specific stack.

Most of the methods in this class are optimized with the assumption that the List will have have constant-time random access. If this is not the case, you should probably at least override listIterator(int) and the xAll() methods (such as addAll(int, java.util.Collection<? extends K>)) with a more appropriate iteration scheme. Note the subList(int, int) method is cognizant of random-access or not, so that need not be reimplemented.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractObjectList.ObjectRandomAccessSubList<K>
static class	AbstractObjectList.ObjectSubList<K>	A class implementing a sublist view.

Method Summary

Modifier and Type	Method	Description
void	add(int index, K k)
boolean	add(K k)
boolean	addAll(int index, java.util.Collection<? extends K> c)	Adds all of the elements in the specified collection to this list (optional operation).
boolean	addAll(java.util.Collection<? extends K> c)
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	clear()
int	compareTo(java.util.List<? extends K> l)	Compares this list to another object.
boolean	contains(java.lang.Object k)	Returns true if this list contains the specified element.
boolean	equals(java.lang.Object o)
void	forEach(java.util.function.Consumer<? super K> action)
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.
int	hashCode()	Returns the hash code for this list, which is identical to List.hashCode().
int	indexOf(java.lang.Object k)
ObjectListIterator<K>	iterator()	Returns a type-specific iterator on the elements of this collection.
int	lastIndexOf(java.lang.Object k)
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.
K	peek(int i)	Peeks at an element on the stack (optional operation).
K	pop()	Pops the top off the stack.
void	push(K o)	Pushes the given object on the stack.
K	remove(int i)
void	removeElements(int from, int to)	Removes (hopefully quickly) elements of this type-specific list.
K	set(int index, K k)
void	setElements(int index, K[] a, int offset, int length)	Set (hopefully quickly) elements to match the array given.
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.
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)
K	top()	Peeks at the top of the stack (optional operation).
java.lang.String	toString()

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, remove, removeAll, retainAll, size

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.util.List

containsAll, get, isEmpty, remove, removeAll, replaceAll, retainAll, size

Methods inherited from interface it.unimi.dsi.fastutil.objects.ObjectCollection

spliterator

Methods inherited from interface it.unimi.dsi.fastutil.objects.ObjectList

addAll, addAll, setElements, setElements, sort, spliterator, unstableSort

Methods inherited from interface it.unimi.dsi.fastutil.Stack

isEmpty

Method Detail

add

public void add(int index,
                K k)

Specified by:

add in interface java.util.List<K>

Implementation Specification:

This implementation always throws an UnsupportedOperationException.

add

public boolean add(K k)

Specified by:

add in interface java.util.Collection<K>

Specified by:

add in interface java.util.List<K>

Overrides:

add in class java.util.AbstractCollection<K>

Implementation Specification:

This implementation delegates to the type-specific version of List.add(int, Object).

remove

public K remove(int i)

Specified by:

remove in interface java.util.List<K>

Implementation Specification:

This implementation always throws an UnsupportedOperationException.

set

public K set(int index,
             K k)

Specified by:

set in interface java.util.List<K>

Implementation Specification:

This implementation always throws an UnsupportedOperationException.

addAll

public boolean addAll(int index,
                      java.util.Collection<? extends K> c)

Adds all of the elements in the specified collection to this list (optional operation).

Specified by:

addAll in interface java.util.List<K>

addAll

public boolean addAll(java.util.Collection<? extends K> c)

Specified by:

addAll in interface java.util.Collection<K>

Specified by:

addAll in interface java.util.List<K>

Overrides:

addAll in class java.util.AbstractCollection<K>

Implementation Specification:

This implementation delegates to the type-specific version of List.addAll(int, Collection).

iterator

public ObjectListIterator<K> iterator()

Returns a type-specific iterator on the elements of this collection.

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>

Specified by:

iterator in interface ObjectList<K>

Specified by:

iterator in class AbstractObjectCollection<K>

Returns:

a type-specific iterator on the elements of this collection.

See Also:

Iterable.iterator()

Implementation Specification:

This implementation delegates to listIterator().

listIterator

public ObjectListIterator<K> listIterator()

Returns a type-specific list iterator on the list.

Specified by:

listIterator in interface java.util.List<K>

Specified by:

listIterator in interface ObjectList<K>

See Also:

List.listIterator()

Implementation Specification:

This implementation delegates to listIterator(0).

listIterator

public 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>

Specified by:

listIterator in interface ObjectList<K>

See Also:

List.listIterator(int)

Implementation Specification:

This implementation is based on the random-access methods.

contains

public boolean contains(java.lang.Object k)

Returns true if this list contains the specified element.

Specified by:

contains in interface java.util.Collection<K>

Specified by:

contains in interface java.util.List<K>

Overrides:

contains in class java.util.AbstractCollection<K>

See Also:

List.contains(Object)

Implementation Specification:

This implementation delegates to indexOf().

indexOf

public int indexOf(java.lang.Object k)

Specified by:

indexOf in interface java.util.List<K>

lastIndexOf

public int lastIndexOf(java.lang.Object k)

Specified by:

lastIndexOf in interface java.util.List<K>

size

public void size(int size)

Description copied from interface: ObjectList

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.

Specified by:

size in interface ObjectList<K>

Parameters:

size - the new size.

subList

public ObjectList<K> subList(int from,
                             int to)

Description copied from interface: ObjectList

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>

Specified by:

subList in interface ObjectList<K>

See Also:

List.subList(int,int)

forEach

public void forEach(java.util.function.Consumer<? super K> action)

Specified by:

forEach in interface java.lang.Iterable<K>

Implementation Specification:

If this list is RandomAccess, will iterate using a for loop and the type-specific List.get(int) method. Otherwise it will fallback to using the iterator based loop implementation from the superinterface.

removeElements

public void removeElements(int from,
                           int to)

Removes (hopefully quickly) elements of this type-specific list.

This is a trivial iterator-based based implementation. It is expected that implementations will override this method with a more optimized version.

Specified by:

removeElements in interface ObjectList<K>

Parameters:

from - the start index (inclusive).

to - the end index (exclusive).

addElements

public void addElements(int index,
                        K[] a,
                        int offset,
                        int length)

Add (hopefully quickly) elements to this type-specific list.

This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

Specified by:

addElements in interface ObjectList<K>

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.

addElements

public void addElements(int index,
                        K[] a)

Add (hopefully quickly) elements to this type-specific list.

Specified by:

addElements in interface ObjectList<K>

Parameters:

index - the index at which to add elements.

a - the array containing the elements.

Implementation Specification:

This implementation delegates to the analogous method for array fragments.

getElements

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

This is a trivial iterator-based implementation. It is expected that implementations will override this method with a more optimized version.

Specified by:

getElements in interface ObjectList<K>

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.

setElements

public void setElements(int index,
                        K[] a,
                        int offset,
                        int length)

Description copied from interface: ObjectList

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.

Specified by:

setElements in interface ObjectList<K>

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.

clear

public void clear()

Specified by:

clear in interface java.util.Collection<K>

Specified by:

clear in interface java.util.List<K>

Overrides:

clear in class java.util.AbstractCollection<K>

Implementation Specification:

This implementation delegates to removeElements(int, int).

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<K>

Specified by:

toArray in interface java.util.List<K>

Overrides:

toArray in class java.util.AbstractCollection<K>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface java.util.Collection<K>

Specified by:

toArray in interface java.util.List<K>

Overrides:

toArray in class java.util.AbstractCollection<K>

hashCode

public int hashCode()

Returns the hash code for this list, which is identical to List.hashCode().

Specified by:

hashCode in interface java.util.Collection<K>

Specified by:

hashCode in interface java.util.List<K>

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code for this list.

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Collection<K>

Specified by:

equals in interface java.util.List<K>

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(java.util.List<? extends K> l)

Compares this list to another object. If the argument is a List, this method performs a lexicographical comparison; otherwise, it throws a ClassCastException.

Specified by:

compareTo in interface java.lang.Comparable<K>

Parameters:

l - a list.

Returns:

if the argument is a List, a negative integer, zero, or a positive integer as this list is lexicographically less than, equal to, or greater than the argument.

Throws:

java.lang.ClassCastException - if the argument is not a list.

push

public void push(K o)

Description copied from interface: Stack

Pushes the given object on the stack.

Specified by:

push in interface Stack<K>

Parameters:

o - the object that will become the new top of the stack.

pop

public K pop()

Description copied from interface: Stack

Pops the top off the stack.

Specified by:

pop in interface Stack<K>

Returns:

the top of the stack.

top

public K top()

Description copied from interface: Stack

Peeks at the top of the stack (optional operation).

This default implementation returns peek(0).

Specified by:

top in interface Stack<K>

Returns:

the top of the stack.

peek

public K peek(int i)

Description copied from interface: Stack

Peeks at an element on the stack (optional operation).

This default implementation just throws an UnsupportedOperationException.

Specified by:

peek in interface Stack<K>

Parameters:

i - an index from the stop of the stack (0 represents the top).

Returns:

the i-th element on the stack.

toString

public java.lang.String toString()

Overrides:

toString in class AbstractObjectCollection<K>