it.unimi.dsi.fastutil.bytes
Class AbstractByteList

java.lang.Object
  it.unimi.dsi.fastutil.bytes.AbstractByteCollection
      it.unimi.dsi.fastutil.bytes.AbstractByteList

All Implemented Interfaces:

ByteCollection, ByteList, ByteStack, Collection, Comparable, List, Stack

Direct Known Subclasses:

ByteArrayList, ByteLists.Singleton

public abstract class AbstractByteList

extends AbstractByteCollection

implements ByteList, ByteStack

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.

Method Summary

void	add(int index, byte k)
void	add(int index, Object ok) Delegates to the corresponding type-specific method.
boolean	addAll(ByteCollection c) Delegates to a more generic method.
boolean	addAll(ByteList l) Delegates to a more generic method.
boolean	addAll(Collection c) Delegates to a more generic method.
boolean	addAll(int index, ByteCollection c) Delegates to a more generic method.
boolean	addAll(int index, ByteList l) Delegates to a more generic method.
boolean	addAll(int index, Collection c)
void	addElements(int index, byte[] a) Add (hopefully quickly) elements to this type-specific list.
void	addElements(int index, byte[] a, int offset, int length) Adds elements to this type-specific list one-by-one.
ByteIterator	byteIterator() Delegates to the corresponding list-iterator method.
ByteListIterator	byteListIterator() Delegates to the corresponding list-iterator method.
ByteList	byteSubList(int from, int to)
int	compareTo(Object o) Compares this list to another object.
boolean	contains(byte k)
boolean	equals(Object o)
Object	get(int index) Delegates to the corresponding type-specific method.
void	getElements(int from, byte[] 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(byte k)
int	indexOf(Object ok) Delegates to the corresponding type-specific method.
int	lastIndexOf(byte k)
int	lastIndexOf(Object ok) Delegates to the corresponding type-specific method.
ListIterator	listIterator() Delegates to the corresponding type-specific method.
ListIterator	listIterator(int index) Delegates to the corresponding type-specific method.
Object	peek(int i) Delegates to the corresponding type-specific method.
byte	peekByte(int i)
Object	pop() Delegates to the corresponding type-specific method.
byte	popByte()
void	push(byte o)
void	push(Object o) Delegates to the corresponding type-specific method.
boolean	rem(byte k) Note that this method should be called remove(), but the clash with the similarly named index-based method in the List interface forces us to use a distinguished name.
Object	remove(int index) Delegates to the corresponding type-specific method.
byte	removeByte(int i)
void	removeElements(int from, int to) Removes elements of this type-specific list one-by-one.
byte	set(int index, byte k)
Object	set(int index, Object ok) Delegates to the corresponding type-specific method.
void	size(int size) Sets the size of this list.
List	subList(int from, int to) Delegates to the corresponding type-specific method.
Object	top() Delegates to the corresponding type-specific method.
byte	topByte()
String	toString()

Methods inherited from class it.unimi.dsi.fastutil.bytes.AbstractByteCollection

add, add, clear, contains, containsAll, containsAll, isEmpty, iterator, rem, remove, removeAll, removeAll, retainAll, retainAll, toArray, toArray, toArray, toByteArray, toByteArray

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteList

byteListIterator, getByte

Methods inherited from interface java.util.List

add, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface it.unimi.dsi.fastutil.bytes.ByteCollection

add, containsAll, removeAll, retainAll, toArray, toByteArray, toByteArray

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

isEmpty

Method Detail

add

public void add(int index,
                byte k)

Specified by:

add in interface ByteList

See Also:

List.add(int,Object)

rem

public boolean rem(byte k)

Description copied from interface: ByteCollection

Note that this method should be called remove(), but the clash with the similarly named index-based method in the List interface forces us to use a distinguished name. For simplicity, the set interfaces reinstates remove().

Specified by:

rem in interface ByteCollection

Overrides:

rem in class AbstractByteCollection

removeByte

public byte removeByte(int i)

Specified by:

removeByte in interface ByteList

See Also:

List.remove(int)

set

public byte set(int index,
                byte k)

Specified by:

set in interface ByteList

See Also:

List.set(int,Object)

addAll

public boolean addAll(int index,
                      Collection c)

Specified by:

addAll in interface List

addAll

public boolean addAll(int index,
                      ByteCollection c)

Delegates to a more generic method.

Specified by:

addAll in interface ByteList

See Also:

List.add(int,Object)

addAll

public boolean addAll(int index,
                      ByteList l)

Delegates to a more generic method.

Specified by:

addAll in interface ByteList

See Also:

List.add(int,Object)

addAll

public boolean addAll(Collection c)

Delegates to a more generic method.

Specified by:

addAll in interface List

Overrides:

addAll in class AbstractByteCollection

Parameters:

c - a collection.

Returns:

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

addAll

public boolean addAll(ByteCollection c)

Delegates to a more generic method.

Specified by:

addAll in interface ByteCollection

Overrides:

addAll in class AbstractByteCollection

Parameters:

c - a type-specific collection.

Returns:

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

addAll

public boolean addAll(ByteList l)

Delegates to a more generic method.

Specified by:

addAll in interface ByteList

See Also:

List.add(int,Object)

listIterator

public ListIterator listIterator()

Delegates to the corresponding type-specific method.

Specified by:

listIterator in interface List

listIterator

public ListIterator listIterator(int index)

Delegates to the corresponding type-specific method.

Specified by:

listIterator in interface List

byteIterator

public ByteIterator byteIterator()

Delegates to the corresponding list-iterator method.

Specified by:

byteIterator in interface ByteCollection

See Also:

Collection.iterator()

byteListIterator

public ByteListIterator byteListIterator()

Delegates to the corresponding list-iterator method.

Specified by:

byteListIterator in interface ByteList

See Also:

List.listIterator()

contains

public boolean contains(byte k)

Specified by:

contains in interface ByteCollection

See Also:

Collection.contains(Object)

indexOf

public int indexOf(byte k)

Specified by:

indexOf in interface ByteList

See Also:

List.indexOf(Object)

lastIndexOf

public int lastIndexOf(byte k)

Specified by:

lastIndexOf in interface ByteList

See Also:

List.lastIndexOf(Object)

size

public void size(int size)

Description copied from interface: ByteList

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 ByteList

Parameters:

size - the new size.

byteSubList

public ByteList byteSubList(int from,
                            int to)

Specified by:

byteSubList in interface ByteList

See Also:

List.subList(int,int)

subList

public List subList(int from,
                    int to)

Delegates to the corresponding type-specific method.

Specified by:

subList in interface List

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 ByteList

Parameters:

from - the start index (inclusive).

to - the end index (exclusive).

addElements

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

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,
                        byte[] a)

Description copied from interface: ByteList

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

Specified by:

addElements in interface ByteList

Parameters:

index - the index at which to add elements.

a - the array containing the elements.

getElements

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

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 List

compareTo

public int compareTo(Object o)

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

Parameters:

o - an object.

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 List

Returns:

the hash code for this list.

push

public void push(byte o)

Specified by:

push in interface ByteStack

See Also:

Stack.push(Object)

popByte

public byte popByte()

Specified by:

popByte in interface ByteStack

See Also:

Stack.pop()

topByte

public byte topByte()

Specified by:

topByte in interface ByteStack

See Also:

Stack.top()

peekByte

public byte peekByte(int i)

Specified by:

peekByte in interface ByteStack

See Also:

Stack.peek(int)

add

public void add(int index,
                Object ok)

Delegates to the corresponding type-specific method.

Specified by:

add in interface List

set

public Object set(int index,
                  Object ok)

Delegates to the corresponding type-specific method.

Specified by:

set in interface List

get

public Object get(int index)

Delegates to the corresponding type-specific method.

Specified by:

get in interface List

indexOf

public int indexOf(Object ok)

Delegates to the corresponding type-specific method.

Specified by:

indexOf in interface List

lastIndexOf

public int lastIndexOf(Object ok)

Delegates to the corresponding type-specific method.

Specified by:

lastIndexOf in interface List

remove

public Object remove(int index)

Delegates to the corresponding type-specific method.

Specified by:

remove in interface List

push

public void push(Object o)

Delegates to the corresponding type-specific method.

Specified by:

push in interface Stack

Parameters:

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

pop

public Object pop()

Delegates to the corresponding type-specific method.

Specified by:

pop in interface Stack

Returns:

the top of the stack.

top

public Object top()

Delegates to the corresponding type-specific method.

Specified by:

top in interface Stack

Returns:

the top of the stack.

peek

public Object peek(int i)

Delegates to the corresponding type-specific method.

Specified by:

peek in interface Stack

Returns:

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

toString

public String toString()

Overrides:

toString in class AbstractByteCollection