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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	add(int index, K k) This implementation always throws an UnsupportedOperationException.
boolean	add(K k) This implementation delegates to the type-specific version of List.add(int, Object).
boolean	addAll(java.util.Collection<? extends K> c) This implementation delegates to the type-specific version of List.addAll(int, Collection).
boolean	addAll(int index, java.util.Collection<? extends K> c) Adds all of the elements in the specified collection to this 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	clear() This implementation delegates to removeElements(int, int).
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	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) This implementation always throws an UnsupportedOperationException.
void	removeElements(int from, int to) Removes (hopefully quickly) elements of this type-specific list.
K	set(int index, K k) This implementation always throws an UnsupportedOperationException.
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.
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, toArray, toArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, get, isEmpty, remove, removeAll, replaceAll, retainAll, size, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

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

isEmpty

Method Detail

add

public void add(int index,
                K k)

This implementation always throws an UnsupportedOperationException.

Specified by:

add in interface java.util.List<K>

add

public boolean add(K k)

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

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>

remove

public K remove(int i)

This implementation always throws an UnsupportedOperationException.

Specified by:

remove in interface java.util.List<K>

set

public K set(int index,
             K k)

This implementation always throws an UnsupportedOperationException.

Specified by:

set in interface java.util.List<K>

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)

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

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>

iterator

public ObjectListIterator<K> iterator()

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

Note that this specification strengthens the one given in Iterable.iterator(), which was already strengthened in the corresponding type-specific class, but was weakened by the fact that this interface extends Collection.

This implementation delegates to listIterator().

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 interface java.lang.Iterable<K>

Specified by:

iterator in interface java.util.Collection<K>

Specified by:

iterator in interface java.util.List<K>

Specified by:

iterator in class AbstractObjectCollection<K>

Returns:

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

See Also:

Iterable.iterator()

listIterator

public ObjectListIterator<K> listIterator()

Returns a type-specific list iterator on the list.

This implementation delegates to listIterator(0).

Specified by:

listIterator in interface ObjectList<K>

Specified by:

listIterator in interface java.util.List<K>

See Also:

List.listIterator()

listIterator

public ObjectListIterator<K> listIterator(int index)

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

This implementation is based on the random-access methods.

Specified by:

listIterator in interface ObjectList<K>

Specified by:

listIterator in interface java.util.List<K>

See Also:

List.listIterator(int)

contains

public boolean contains(java.lang.Object k)

Returns true if this list contains the specified element.

This implementation delegates to indexOf().

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)

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.

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

Specified by:

subList in interface ObjectList<K>

Specified by:

subList in interface java.util.List<K>

See Also:

List.subList(int,int)

removeElements

public void removeElements(int from,
                           int to)

Removes (hopefully quickly) elements of 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:

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.

This implementation delegates to the analogous method for array fragments.

Specified by:

addElements in interface ObjectList<K>

Parameters:

index - the index at which to add elements.

a - the array containing the elements.

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.

clear

public void clear()

This implementation delegates to removeElements(int, int).

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>

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