it.unimi.dsi.fastutil.shorts

Class AbstractShortList

java.lang.Object

java.util.AbstractCollection<Short>

it.unimi.dsi.fastutil.shorts.AbstractShortCollection

it.unimi.dsi.fastutil.shorts.AbstractShortList

All Implemented Interfaces:

ShortCollection, ShortIterable, ShortList, ShortStack, Stack<Short>, Comparable<List<? extends Short>>, Iterable<Short>, Collection<Short>, List<Short>

Direct Known Subclasses:

AbstractShortList.ShortSubList, ShortArrayList, ShortLists.Singleton

public abstract class AbstractShortList
extends AbstractShortCollection
implements ShortList, ShortStack

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	AbstractShortList.ShortSubList A class implementing a sublist view.

Method Summary

Modifier and Type	Method and Description
void	add(int index, short k) Inserts the specified element at the specified position in this list (optional operation).
boolean	add(short k) Ensures that this collection contains the specified element (optional operation).
boolean	addAll(Collection<? extends Short> c) This implementation delegates to the type-specific version of List.addAll(int, Collection).
boolean	addAll(int index, Collection<? extends Short> c) Adds all of the elements in the specified collection to this list (optional operation).
boolean	addAll(int index, ShortCollection c) Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).
boolean	addAll(int index, ShortList l) Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).
boolean	addAll(ShortCollection c) Adds all elements of the given type-specific collection to this collection.
boolean	addAll(ShortList 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, short[] a) Add (hopefully quickly) elements to this type-specific list.
void	addElements(int index, short[] 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(List<? extends Short> l) Compares this list to another object.
boolean	contains(short k) Returns true if this list contains the specified element.
boolean	equals(Object o)
void	getElements(int from, short[] 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(short k) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
ShortListIterator	iterator() Returns a type-specific iterator on the elements of this collection.
int	lastIndexOf(short k) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.
ShortListIterator	listIterator() Returns a type-specific list iterator on the list.
ShortListIterator	listIterator(int index) Returns a type-specific list iterator on the list starting at a given index.
short	peekShort(int i) Peeks at an element on the stack (optional operation).
short	popShort() Pops the top off the stack.
void	push(short o) Pushes the given object on the stack.
boolean	rem(short k) Removes a single instance of the specified element from this collection, if it is present (optional operation).
void	removeElements(int from, int to) Removes (hopefully quickly) elements of this type-specific list.
short	removeShort(int i) Removes the element at the specified position in this list (optional operation).
short	set(int index, short k) Replaces the element at the specified position in this list with the specified element (optional operation).
void	size(int size) Sets the size of this list.
ShortList	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.
short	topShort() Peeks at the top of the stack (optional operation).
String	toString()

Methods inherited from class it.unimi.dsi.fastutil.shorts.AbstractShortCollection

add, contains, containsAll, remove, removeAll, retainAll, toArray, toShortArray, toShortArray

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, removeAll, retainAll, size, toArray, toArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.shorts.ShortList

add, add, contains, get, getShort, indexOf, lastIndexOf, remove, remove, set, setElements, setElements, setElements, sort, sort, unstableSort, unstableSort

Methods inherited from interface java.util.List

containsAll, isEmpty, removeAll, replaceAll, retainAll, size, spliterator, toArray, toArray

Methods inherited from interface it.unimi.dsi.fastutil.shorts.ShortCollection

containsAll, removeAll, removeIf, removeIf, retainAll, toArray, toShortArray, toShortArray

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface it.unimi.dsi.fastutil.shorts.ShortIterable

forEach, forEach

Methods inherited from interface it.unimi.dsi.fastutil.shorts.ShortStack

peek, pop, push, top

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

isEmpty

Method Detail

add

public void add(int index,
                short k)

Inserts the specified element at the specified position in this list (optional operation).

This implementation always throws an UnsupportedOperationException.

Specified by:

add in interface ShortList

See Also:

List.add(int,Object)

add

public boolean add(short k)

Ensures that this collection contains the specified element (optional operation).

This implementation always throws an UnsupportedOperationException.

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

Specified by:

add in interface ShortCollection

Specified by:

add in interface ShortList

Overrides:

add in class AbstractShortCollection

See Also:

Collection.add(Object)

removeShort

public short removeShort(int i)

Removes the element at the specified position in this list (optional operation).

This implementation always throws an UnsupportedOperationException.

Specified by:

removeShort in interface ShortList

See Also:

List.remove(int)

set

public short set(int index,
                 short k)

Replaces the element at the specified position in this list with the specified element (optional operation).

This implementation always throws an UnsupportedOperationException.

Specified by:

set in interface ShortList

See Also:

List.set(int,Object)

addAll

public boolean addAll(int index,
                      Collection<? extends Short> c)

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

Specified by:

addAll in interface List<Short>

addAll

public boolean addAll(Collection<? extends Short> c)

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

Specified by:

addAll in interface Collection<Short>

Specified by:

addAll in interface List<Short>

Overrides:

addAll in class AbstractCollection<Short>

iterator

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

Specified by:

iterator in interface ShortIterable

Specified by:

iterator in interface ShortList

Specified by:

iterator in interface Iterable<Short>

Specified by:

iterator in interface Collection<Short>

Specified by:

iterator in interface List<Short>

Specified by:

iterator in class AbstractShortCollection

Returns:

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

See Also:

Iterable.iterator()

listIterator

public ShortListIterator listIterator()

Returns a type-specific list iterator on the list.

This implementation delegates to listIterator(0).

Specified by:

listIterator in interface ShortList

Specified by:

listIterator in interface List<Short>

See Also:

List.listIterator()

listIterator

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

Specified by:

listIterator in interface List<Short>

See Also:

List.listIterator(int)

contains

public boolean contains(short k)

Returns true if this list contains the specified element.

This implementation delegates to indexOf().

Specified by:

contains in interface ShortCollection

Overrides:

contains in class AbstractShortCollection

See Also:

List.contains(Object)

indexOf

public int indexOf(short k)

Description copied from interface: ShortList

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.

Specified by:

indexOf in interface ShortList

See Also:

List.indexOf(Object)

lastIndexOf

public int lastIndexOf(short k)

Description copied from interface: ShortList

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.

Specified by:

lastIndexOf in interface ShortList

See Also:

List.lastIndexOf(Object)

size

public void size(int size)

Description copied from interface: ShortList

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 ShortList

Parameters:

size - the new size.

subList

public ShortList subList(int from,
                         int to)

Description copied from interface: ShortList

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 ShortList

Specified by:

subList in interface List<Short>

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 ShortList

Parameters:

from - the start index (inclusive).

to - the end index (exclusive).

addElements

public void addElements(int index,
                        short[] 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 ShortList

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,
                        short[] 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 ShortList

Parameters:

index - the index at which to add elements.

a - the array containing the elements.

getElements

public void getElements(int from,
                        short[] 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 ShortList

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 Collection<Short>

Specified by:

clear in interface List<Short>

Overrides:

clear in class AbstractCollection<Short>

hashCode

public int hashCode()

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

Specified by:

hashCode in interface Collection<Short>

Specified by:

hashCode in interface List<Short>

Overrides:

hashCode in class Object

Returns:

the hash code for this list.

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<Short>

Specified by:

equals in interface List<Short>

Overrides:

equals in class Object

compareTo

public int compareTo(List<? extends Short> 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 Comparable<List<? extends Short>>

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:

ClassCastException - if the argument is not a list.

push

public void push(short o)

Description copied from interface: ShortStack

Pushes the given object on the stack.

Specified by:

push in interface ShortStack

Parameters:

o - the object to push on the stack.

See Also:

Stack.push(Object)

popShort

public short popShort()

Description copied from interface: ShortStack

Pops the top off the stack.

Specified by:

popShort in interface ShortStack

Returns:

the top of the stack.

See Also:

Stack.pop()

topShort

public short topShort()

Description copied from interface: ShortStack

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

Specified by:

topShort in interface ShortStack

Returns:

the top of the stack.

See Also:

Stack.top()

peekShort

public short peekShort(int i)

Description copied from interface: ShortStack

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

Specified by:

peekShort in interface ShortStack

Parameters:

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

Returns:

the i-th element on the stack.

See Also:

Stack.peek(int)

rem

public boolean rem(short k)

Removes a single instance of the specified element from this collection, if it is present (optional operation).

This implementation delegates to indexOf().

Specified by:

rem in interface ShortCollection

Overrides:

rem in class AbstractShortCollection

See Also:

List.remove(Object)

addAll

public boolean addAll(int index,
                      ShortCollection c)

Description copied from interface: ShortList

Inserts all of the elements in the specified type-specific collection into this type-specific list at the specified position (optional operation).

Specified by:

addAll in interface ShortList

See Also:

List.addAll(int,java.util.Collection)

addAll

public boolean addAll(int index,
                      ShortList l)

Inserts all of the elements in the specified type-specific list into this type-specific list at the specified position (optional operation).

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

Specified by:

addAll in interface ShortList

See Also:

List.add(int,Object)

addAll

public boolean addAll(ShortCollection c)

Adds all elements of the given type-specific collection to this collection.

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

Specified by:

addAll in interface ShortCollection

Overrides:

addAll in class AbstractShortCollection

Parameters:

c - a type-specific collection.

Returns:

true if this collection changed as a result of the call.

See Also:

Collection.addAll(Collection)

addAll

public boolean addAll(ShortList l)

Appends all of the elements in the specified type-specific list to the end of this type-specific list (optional operation).

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

Specified by:

addAll in interface ShortList

See Also:

List.add(int,Object)

toString

public String toString()

Overrides:

toString in class AbstractShortCollection