Package org.codelibs.jhighlight.fastutil.objects

Class AbstractObjectList<K>

java.lang.Object

java.util.AbstractCollection<K>

org.codelibs.jhighlight.fastutil.objects.AbstractObjectCollection<K>

org.codelibs.jhighlight.fastutil.objects.AbstractObjectList<K>

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractObjectList.ObjectSubList, ObjectArrayList

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	Description
static class	AbstractObjectList.ObjectSubList<K>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractObjectList()

Method Summary

Modifier and Type	Method	Description
void	add(int index, K k)
boolean	add(K k)
boolean	addAll(int index, Collection<? extends K> c)
boolean	addAll(Collection<? extends K> c)	Delegates to a more generic method.
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)	Adds elements to this type-specific list one-by-one.
int	compareTo(List<? extends K> l)	Compares this list to another object.
boolean	contains(Object k)
protected void	ensureIndex(int index)	Ensures that the given index is nonnegative and not greater than the list size.
protected void	ensureRestrictedIndex(int index)	Ensures that the given index is nonnegative and smaller than the list size.
boolean	equals(Object o)
void	getElements(int from, Object[] a, int offset, int length)	Copies element of this type-specific list into the given array one-by-one.
int	hashCode()	Returns the hash code for this list, which is identical to List.hashCode().
int	indexOf(Object k)
ObjectListIterator<K>	iterator()	Returns a type-specific iterator on the elements of this collection.
int	lastIndexOf(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.
ObjectListIterator<K>	objectListIterator()	Deprecated.
ObjectListIterator<K>	objectListIterator(int index)	Deprecated.
ObjectList<K>	objectSubList(int from, int to)	Deprecated.
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 elements of this type-specific list one-by-one.
K	set(int index, K k)
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).
String	toString()

Methods inherited from class org.codelibs.jhighlight.fastutil.objects.AbstractObjectCollection

containsAll, isEmpty, objectIterator, removeAll, retainAll, toArray, toArray

Methods inherited from class java.util.AbstractCollection

clear, remove, size

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

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

Methods inherited from interface org.codelibs.jhighlight.fastutil.objects.ObjectCollection

objectIterator, toArray

Methods inherited from interface org.codelibs.jhighlight.fastutil.Stack

isEmpty

Constructor Detail

AbstractObjectList

protected AbstractObjectList()

Method Detail

ensureIndex

protected void ensureIndex(int index)

Ensures that the given index is nonnegative and not greater than the list size.

Parameters:

index - an index.

Throws:

IndexOutOfBoundsException - if the given index is negative or greater than the list size.

ensureRestrictedIndex

protected void ensureRestrictedIndex(int index)

Ensures that the given index is nonnegative and smaller than the list size.

Parameters:

index - an index.

Throws:

IndexOutOfBoundsException - if the given index is negative or not smaller than the list size.

add

public void add(int index,
                K k)

Specified by:

add in interface List<K>

add

public boolean add(K k)

Specified by:

add in interface Collection<K>

Specified by:

add in interface List<K>

Overrides:

add in class AbstractObjectCollection<K>

remove

public K remove(int i)

Specified by:

remove in interface List<K>

set

public K set(int index,
             K k)

Specified by:

set in interface List<K>

addAll

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

Specified by:

addAll in interface List<K>

addAll

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

Delegates to a more generic method.

Specified by:

addAll in interface Collection<K>

Specified by:

addAll in interface List<K>

Overrides:

addAll in class AbstractObjectCollection<K>

Parameters:

c - a collection.

Returns:

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

objectListIterator

@Deprecated
public ObjectListIterator<K> objectListIterator()

Deprecated.

Delegates to the new covariantly stronger generic method.

Specified by:

objectListIterator in interface ObjectList<K>

See Also:

ObjectList.listIterator()

objectListIterator

@Deprecated
public ObjectListIterator<K> objectListIterator(int index)

Deprecated.

Delegates to the new covariantly stronger generic method.

Specified by:

objectListIterator in interface ObjectList<K>

See Also:

ObjectList.listIterator(int)

iterator

public ObjectListIterator<K> iterator()

Description copied from interface: ObjectCollection

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.

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>

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.

listIterator

public ObjectListIterator<K> listIterator()

Description copied from interface: ObjectList

Returns a type-specific list iterator on the list.

Specified by:

listIterator in interface List<K>

Specified by:

listIterator in interface ObjectList<K>

See Also:

List.listIterator()

listIterator

public ObjectListIterator<K> listIterator(int index)

Description copied from interface: ObjectList

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

Specified by:

listIterator in interface List<K>

Specified by:

listIterator in interface ObjectList<K>

See Also:

List.listIterator(int)

contains

public boolean contains(Object k)

Specified by:

contains in interface Collection<K>

Specified by:

contains in interface List<K>

Overrides:

contains in class AbstractCollection<K>

indexOf

public int indexOf(Object k)

Specified by:

indexOf in interface List<K>

lastIndexOf

public int lastIndexOf(Object k)

Specified by:

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

Specified by:

subList in interface ObjectList<K>

See Also:

List.subList(int,int)

objectSubList

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

Deprecated.

Delegates to the new covariantly stronger generic method.

Specified by:

objectSubList in interface ObjectList<K>

See Also:

List.subList(int,int)

removeElements

public void removeElements(int from,
                           int to)

Removes elements of this type-specific list one-by-one.

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)

Adds elements to this type-specific list one-by-one.

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)

Description copied from interface: ObjectList

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.

getElements

public void getElements(int from,
                        Object[] a,
                        int offset,
                        int length)

Copies element of this type-specific list into the given array one-by-one.

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.

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<K>

Specified by:

equals in interface List<K>

Overrides:

equals in class Object

compareTo

public int compareTo(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 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:

ClassCastException - if the argument is not a list.

hashCode

public int hashCode()

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

Specified by:

hashCode in interface Collection<K>

Specified by:

hashCode in interface List<K>

Overrides:

hashCode in class Object

Returns:

the hash code for this 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).

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

Specified by:

peek in interface Stack<K>

Returns:

the i-th element on the stack; 0 represents the top.

toString

public String toString()

Overrides:

toString in class AbstractObjectCollection<K>