it.unimi.dsi.fastutil.bytes

Class AbstractByteList

java.lang.Object

java.util.AbstractCollection<java.lang.Byte>

it.unimi.dsi.fastutil.bytes.AbstractByteCollection

it.unimi.dsi.fastutil.bytes.AbstractByteList

All Implemented Interfaces:

ByteCollection, ByteIterable, ByteList, ByteStack, it.unimi.dsi.fastutil.Stack<java.lang.Byte>, java.lang.Comparable<java.util.List<? extends java.lang.Byte>>, java.lang.Iterable<java.lang.Byte>, java.util.Collection<java.lang.Byte>, java.util.List<java.lang.Byte>

Direct Known Subclasses:

AbstractByteList.ByteSubList, ByteArrayList, ByteImmutableList, 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.

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 java.lang.Byte>)) 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 and Description
static class	AbstractByteList.ByteRandomAccessSubList
static class	AbstractByteList.ByteSubList A class implementing a sublist view.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractByteList()

Method Summary

Modifier and Type	Method and Description
boolean	add(byte k) Ensures that this collection contains the specified element (optional operation).
void	add(int index, byte k) Inserts the specified element at the specified position in this list (optional operation).
boolean	addAll(ByteCollection c) Adds all elements of the given type-specific collection to this collection.
boolean	addAll(java.util.Collection<? extends java.lang.Byte> c)
boolean	addAll(int index, ByteCollection 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, java.util.Collection<? extends java.lang.Byte> c) Adds all of the elements in the specified collection to this list (optional operation).
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) Add (hopefully quickly) elements to this type-specific list.
void	clear()
int	compareTo(java.util.List<? extends java.lang.Byte> l) Compares this list to another object.
boolean	contains(byte k) Returns true if this list contains the specified element.
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(java.lang.Object o)
void	forEach(it.unimi.dsi.fastutil.bytes.ByteConsumer action) Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.
void	getElements(int from, byte[] 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(byte 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.
ByteListIterator	iterator() Returns a type-specific iterator on the elements of this collection.
int	lastIndexOf(byte 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.
ByteListIterator	listIterator() Returns a type-specific list iterator on the list.
ByteListIterator	listIterator(int index) Returns a type-specific list iterator on the list starting at a given index.
byte	peekByte(int i) Peeks at an element on the stack (optional operation).
byte	popByte() Pops the top off the stack.
void	push(byte o) Pushes the given object on the stack.
boolean	rem(byte k) Removes a single instance of the specified element from this collection, if it is present (optional operation).
byte	removeByte(int i) Removes the element at the specified position in this list (optional operation).
void	removeElements(int from, int to) Removes (hopefully quickly) elements of this type-specific list.
byte	set(int index, byte k) Replaces the element at the specified position in this list with the specified element (optional operation).
void	setElements(int index, byte[] a, int offset, int length) Set (hopefully quickly) elements to match the array given.
void	size(int size) Sets the size of this list.
ByteList	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.
byte[]	toArray(byte[] a) Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.
byte[]	toByteArray() Returns a primitive type array containing the items of this collection.
byte	topByte() Peeks at the top of the stack (optional operation).
java.lang.String	toString()

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

add, contains, containsAll, containsAll, remove, removeAll, removeAll, retainAll, retainAll, toByteArray

Methods inherited from class java.util.AbstractCollection

isEmpty, size, toArray, toArray

Methods inherited from class java.lang.Object

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

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

add, add, addAll, addAll, contains, get, getByte, indexOf, lastIndexOf, of, of, of, of, of, remove, remove, replaceAll, replaceAll, replaceAll, set, setElements, setElements, sort, sort, spliterator, unstableSort, unstableSort

Methods inherited from interface java.util.List

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

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

containsAll, intIterator, intParallelStream, intSpliterator, intStream, parallelStream, removeAll, removeIf, removeIf, removeIf, retainAll, stream, toByteArray

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

forEach, forEach

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

peek, pop, push, top

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

isEmpty

Constructor Detail

AbstractByteList

protected AbstractByteList()

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:

java.lang.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:

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

add

public void add(int index,
                byte k)

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

Specified by:

add in interface ByteList

See Also:

List.add(int,Object)

add

public boolean add(byte k)

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

Specified by:

add in interface ByteCollection

Specified by:

add in interface ByteList

Overrides:

add in class AbstractByteCollection

See Also:

Collection.add(Object)

removeByte

public byte removeByte(int i)

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

Specified by:

removeByte in interface ByteList

See Also:

List.remove(int)

set

public byte set(int index,
                byte k)

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

Specified by:

set in interface ByteList

See Also:

List.set(int,Object)

addAll

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

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

Specified by:

addAll in interface java.util.List<java.lang.Byte>

addAll

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

Specified by:

addAll in interface java.util.Collection<java.lang.Byte>

Specified by:

addAll in interface java.util.List<java.lang.Byte>

Overrides:

addAll in class AbstractByteCollection

iterator

public ByteListIterator iterator()

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

Specified by:

iterator in interface ByteCollection

Specified by:

iterator in interface ByteIterable

Specified by:

iterator in interface ByteList

Specified by:

iterator in interface java.lang.Iterable<java.lang.Byte>

Specified by:

iterator in interface java.util.Collection<java.lang.Byte>

Specified by:

iterator in interface java.util.List<java.lang.Byte>

Specified by:

iterator in class AbstractByteCollection

Returns:

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

See Also:

Iterable.iterator()

listIterator

public ByteListIterator listIterator()

Returns a type-specific list iterator on the list.

Specified by:

listIterator in interface ByteList

Specified by:

listIterator in interface java.util.List<java.lang.Byte>

See Also:

List.listIterator()

listIterator

public ByteListIterator listIterator(int index)

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

Specified by:

listIterator in interface ByteList

Specified by:

listIterator in interface java.util.List<java.lang.Byte>

See Also:

List.listIterator(int)

contains

public boolean contains(byte k)

Returns true if this list contains the specified element.

Specified by:

contains in interface ByteCollection

Overrides:

contains in class AbstractByteCollection

See Also:

List.contains(Object)

indexOf

public int indexOf(byte k)

Description copied from interface: ByteList

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 ByteList

See Also:

List.indexOf(Object)

lastIndexOf

public int lastIndexOf(byte k)

Description copied from interface: ByteList

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

subList

public ByteList subList(int from,
                        int to)

Description copied from interface: ByteList

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 ByteList

Specified by:

subList in interface java.util.List<java.lang.Byte>

See Also:

List.subList(int,int)

forEach

public void forEach(it.unimi.dsi.fastutil.bytes.ByteConsumer action)

Performs the given action for each element of this type-specific Iterable until all elements have been processed or the action throws an exception.

Specified by:

forEach in interface ByteIterable

Parameters:

action - the action to be performed for each element.

See Also:

Iterable.forEach(java.util.function.Consumer)

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 ByteList

Parameters:

from - the start index (inclusive).

to - the end index (exclusive).

addElements

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

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

setElements

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

Description copied from interface: ByteList

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 ByteList

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<java.lang.Byte>

Specified by:

clear in interface java.util.List<java.lang.Byte>

Overrides:

clear in class java.util.AbstractCollection<java.lang.Byte>

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<java.lang.Byte>

Specified by:

hashCode in interface java.util.List<java.lang.Byte>

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<java.lang.Byte>

Specified by:

equals in interface java.util.List<java.lang.Byte>

Overrides:

equals in class java.lang.Object

compareTo

public int compareTo(java.util.List<? extends java.lang.Byte> 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 java.lang.Byte>>

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(byte o)

Description copied from interface: ByteStack

Pushes the given object on the stack.

Specified by:

push in interface ByteStack

Parameters:

o - the object to push on the stack.

See Also:

Stack.push(Object)

popByte

public byte popByte()

Description copied from interface: ByteStack

Pops the top off the stack.

Specified by:

popByte in interface ByteStack

Returns:

the top of the stack.

See Also:

Stack.pop()

topByte

public byte topByte()

Description copied from interface: ByteStack

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

Specified by:

topByte in interface ByteStack

Returns:

the top of the stack.

See Also:

Stack.top()

peekByte

public byte peekByte(int i)

Description copied from interface: ByteStack

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

Specified by:

peekByte in interface ByteStack

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(byte k)

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

Specified by:

rem in interface ByteCollection

Overrides:

rem in class AbstractByteCollection

See Also:

List.remove(Object)

toByteArray

public byte[] toByteArray()

Description copied from interface: ByteCollection

Returns a primitive type array containing the items of this collection.

Specified by:

toByteArray in interface ByteCollection

Overrides:

toByteArray in class AbstractByteCollection

Returns:

a primitive type array containing the items of this collection.

See Also:

Collection.toArray()

toArray

public byte[] toArray(byte[] a)

Description copied from interface: ByteCollection

Returns an array containing all of the elements in this collection; the runtime type of the returned array is that of the specified array.

Note that, contrarily to Collection.toArray(Object[]), this methods just writes all elements of this collection: no special value will be added after the last one.

Specified by:

toArray in interface ByteCollection

Overrides:

toArray in class AbstractByteCollection

Parameters:

a - if this array is big enough, it will be used to store this collection.

Returns:

a primitive type array containing the items of this collection.

See Also:

Collection.toArray(Object[])

addAll

public boolean addAll(int index,
                      ByteCollection c)

Description copied from interface: ByteList

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 ByteList

See Also:

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

addAll

public boolean addAll(ByteCollection c)

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

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.

See Also:

Collection.addAll(Collection)

toString

public java.lang.String toString()

Overrides:

toString in class AbstractByteCollection