Module org.jhotdraw8.collection

Package org.jhotdraw8.collection.primitive

Class ByteArrayList

java.lang.Object

java.util.AbstractCollection<Byte>

java.util.AbstractList<Byte>

org.jhotdraw8.collection.primitive.ByteArrayList

All Implemented Interfaces:

Iterable<Byte>, Collection<Byte>, List<Byte>, SequencedCollection<Byte>, ByteList, ByteSequencedCollection

public class ByteArrayList
extends AbstractList<Byte>
implements ByteList

A byte-valued list backed by a primitive array.

Author:

Werner Randelshofer

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
ByteArrayList()	Creates a new empty instance with 0 initial capacity.
ByteArrayList(int initialCapacity)	Creates a new empty instance with the specified initial capacity.
ByteArrayList(Collection<Byte> collection)	Creates a new instance from the specified collection

Method Summary

Modifier and Type	Method	Description
boolean	add(Byte e)
void	addAllAsByte(ByteArrayList that)	Adds all items of the specified list to this list.
<T extends Collection<Byte>> T	addAllInto(T out)	Adds all items of this collection to the specified collection.
void	addAsByte(byte newItem)	Adds a new item to the end of the list.
void	addAsByte(int index, byte newItem)	Inserts a new item at the specified index into this list.
void	addFirst(Byte e)
void	addLast(Byte e)
IntStream	byteStream()	Returns a stream for processing the items of this list.
void	clear()	Clears the list in O(1).
boolean	contains(Object o)
void	copyInto(byte[] a, int offset)	Copies the contents of this list into the provided array.
boolean	equals(@Nullable Object obj)
Byte	get(int index)
byte[]	getArray()
byte	getAsByte(int index)	Gets the item at the specified index.
Byte	getFirst()
byte	getFirstAsByte()
Byte	getLast()
byte	getLastAsByte()
int	hashCode()
int	indexOfAsByte(byte item)
int	indexOfAsByte(byte item, int start)
boolean	isEmpty()	Returns true if size==0.
PrimitiveIteratorOfByte	iterator()	Returns an iterator for this list.
int	lastIndexOfAsByte(byte item)
int	lastIndexOfAsByte(byte item, int start)
static ByteArrayList	of(byte... items)	Creates a new instance with the specified items.
boolean	remove(Object o)
byte	removeAtAsByte(int index)	Removes the item at the specified index from this list.
Byte	removeFirst()
boolean	removeIfAsByte(IntPredicate filter)	Removes all the elements of this collection that satisfy the given predicate.
Byte	removeLast()
byte	removeLastAsByte()	Removes the last item
List<Byte>	reversed()
byte	setAsByte(int index, byte newItem)	Replaces the item at the specified index.
void	setSize(int newSize)	Sets the size of this list.
int	size()	Returns the size of the list.
void	sort()	Sorts the items in ascending order.
void	sort(@Nullable Comparator<? super Byte> c)	Sorts this list according to the order induced by the specified Comparator.
SpliteratorOfByte	spliterator()	Returns a spliterator for this list.
byte[]	toByteArray()	Returns a new array containing all the elements in this collection.
int[]	toIntArray()	Returns a new array containing all the elements in this collection.
String	toString()
void	trimToSize()	Trims the capacity of the list its current size.

Methods inherited from class java.util.AbstractList

add, addAll, indexOf, lastIndexOf, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

addAll, containsAll, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jhotdraw8.collection.primitive.ByteList

addFirstAsByte, addLastAsByte, indexOf, lastIndexOf, removeFirstAsByte

Methods inherited from interface org.jhotdraw8.collection.primitive.ByteSequencedCollection

addLastAllAsByte, addLastAllAsByte

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

add, addAll, addAll, containsAll, listIterator, listIterator, remove, removeAll, replaceAll, retainAll, set, subList, toArray, toArray

Constructor Details

ByteArrayList

public ByteArrayList()

Creates a new empty instance with 0 initial capacity.

ByteArrayList

public ByteArrayList(int initialCapacity)

Creates a new empty instance with the specified initial capacity.

Parameters:

initialCapacity - the initial capacity

ByteArrayList

public ByteArrayList(Collection<Byte> collection)

Creates a new instance from the specified collection

Parameters:

collection - a collection of integers

Method Details

of

public static ByteArrayList of(byte... items)

Creates a new instance with the specified items.

Parameters:

items - the items (the newly created instance references the provided array)

Returns:

the new instance

addAsByte

public void addAsByte(byte newItem)

Adds a new item to the end of the list.

Specified by:

addAsByte in interface ByteList

Parameters:

newItem - the new item

See Also:

• List.add(Object)

addAsByte

public void addAsByte(int index,
 byte newItem)

Inserts a new item at the specified index into this list.

Specified by:

addAsByte in interface ByteList

Parameters:

index - the index

newItem - the new item

See Also:

• List.add(int, Object)

addAllAsByte

public void addAllAsByte(ByteArrayList that)

Adds all items of the specified list to this list.

Parameters:

that - another list

addAllInto

public <T extends Collection<Byte>> T addAllInto(T out)

Adds all items of this collection to the specified collection.

Type Parameters:

T - the type of the collection

Parameters:

out - the output collection

Returns:

out

clear

public void clear()

Clears the list in O(1).

Specified by:

clear in interface Collection<Byte>

Specified by:

clear in interface List<Byte>

Overrides:

clear in class AbstractList<Byte>

copyInto

public void copyInto(byte[] a,
 int offset)

Copies the contents of this list into the provided array.

Parameters:

a - an array

offset - the offset into the array

equals

public boolean equals(@Nullable Object obj)

Specified by:

equals in interface Collection<Byte>

Specified by:

equals in interface List<Byte>

Overrides:

equals in class AbstractList<Byte>

getAsByte

public byte getAsByte(int index)

Gets the item at the specified index.

Specified by:

getAsByte in interface ByteList

Parameters:

index - an index

Returns:

the item at the index

See Also:

• List.get(int)

get

public Byte get(int index)

Specified by:

get in interface List<Byte>

Specified by:

get in class AbstractList<Byte>

getLastAsByte

public byte getLastAsByte()

Specified by:

getLastAsByte in interface ByteSequencedCollection

getFirstAsByte

public byte getFirstAsByte()

Specified by:

getFirstAsByte in interface ByteSequencedCollection

setSize

public void setSize(int newSize)

Sets the size of this list. If the new size is greater than the current size, new 0 items are added to the end of the list. If the new size is less than the current size, all items at indices greater or equal newSize are discarded.

Parameters:

newSize - the new size

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<Byte>

Specified by:

hashCode in interface List<Byte>

Overrides:

hashCode in class AbstractList<Byte>

indexOfAsByte

public int indexOfAsByte(byte item)

Specified by:

indexOfAsByte in interface ByteList

See Also:

• List.indexOf(Object)

indexOfAsByte

public int indexOfAsByte(byte item,
 int start)

lastIndexOfAsByte

public int lastIndexOfAsByte(byte item)

Specified by:

lastIndexOfAsByte in interface ByteList

See Also:

• List.lastIndexOf(Object)

lastIndexOfAsByte

public int lastIndexOfAsByte(byte item,
 int start)

isEmpty

public boolean isEmpty()

Returns true if size==0.

Specified by:

isEmpty in interface ByteList

Specified by:

isEmpty in interface Collection<Byte>

Specified by:

isEmpty in interface List<Byte>

Overrides:

isEmpty in class AbstractCollection<Byte>

Returns:

true if empty

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<Byte>

Specified by:

contains in interface List<Byte>

Overrides:

contains in class AbstractCollection<Byte>

removeAtAsByte

public byte removeAtAsByte(int index)

Removes the item at the specified index from this list.

Specified by:

removeAtAsByte in interface ByteList

Parameters:

index - an index

Returns:

the removed item

removeLastAsByte

public byte removeLastAsByte()

Removes the last item

Specified by:

removeLastAsByte in interface ByteSequencedCollection

Returns:

the removed item

Throws:

NoSuchElementException - if the list is empty

setAsByte

public byte setAsByte(int index,
 byte newItem)

Replaces the item at the specified index.

Parameters:

index - an index

newItem - the new item

Returns:

the old item

size

public int size()

Returns the size of the list.

Specified by:

size in interface Collection<Byte>

Specified by:

size in interface List<Byte>

Specified by:

size in class AbstractCollection<Byte>

Returns:

the size

trimToSize

public void trimToSize()

Trims the capacity of the list its current size.

iterator

public PrimitiveIteratorOfByte iterator()

Returns an iterator for this list.

Specified by:

iterator in interface Collection<Byte>

Specified by:

iterator in interface Iterable<Byte>

Specified by:

iterator in interface List<Byte>

Overrides:

iterator in class AbstractList<Byte>

Returns:

an iterator over the elements of this list

spliterator

public SpliteratorOfByte spliterator()

Returns a spliterator for this list.

Specified by:

spliterator in interface Collection<Byte>

Specified by:

spliterator in interface Iterable<Byte>

Specified by:

spliterator in interface List<Byte>

Returns:

a spliterator over the elements of this list

byteStream

public IntStream byteStream()

Returns a stream for processing the items of this list.

Returns:

a stream

toByteArray

public byte[] toByteArray()

Returns a new array containing all the elements in this collection.

Returns:

array

toIntArray

public int[] toIntArray()

Returns a new array containing all the elements in this collection.

Returns:

array

add

public boolean add(Byte e)

Specified by:

add in interface ByteList

Specified by:

add in interface Collection<Byte>

Specified by:

add in interface List<Byte>

Overrides:

add in class AbstractList<Byte>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<Byte>

Specified by:

remove in interface List<Byte>

Overrides:

remove in class AbstractCollection<Byte>

toString

public String toString()

Overrides:

toString in class AbstractCollection<Byte>

sort

public void sort()

Sorts the items in ascending order.

removeIfAsByte

public boolean removeIfAsByte(IntPredicate filter)

Removes all the elements of this collection that satisfy the given predicate.

Parameters:

filter - a predicate which returns true for elements to be removed

Returns:

true if any elements were removed

sort

public void sort(@Nullable Comparator<? super Byte> c)

Sorts this list according to the order induced by the specified Comparator. The sort is stable: it does not reorder equal elements.

Specified by:

sort in interface List<Byte>

Parameters:

c - the Comparator used to compare list elements. A null value indicates that the elements' natural ordering should be used.

reversed

public List<Byte> reversed()

Specified by:

reversed in interface List<Byte>

Specified by:

reversed in interface SequencedCollection<Byte>

getArray

public byte[] getArray()

addFirst

public void addFirst(Byte e)

Specified by:

addFirst in interface ByteList

Specified by:

addFirst in interface ByteSequencedCollection

Specified by:

addFirst in interface List<Byte>

Specified by:

addFirst in interface SequencedCollection<Byte>

addLast

public void addLast(Byte e)

Specified by:

addLast in interface ByteList

Specified by:

addLast in interface ByteSequencedCollection

Specified by:

addLast in interface List<Byte>

Specified by:

addLast in interface SequencedCollection<Byte>

getFirst

public Byte getFirst()

Specified by:

getFirst in interface ByteList

Specified by:

getFirst in interface ByteSequencedCollection

Specified by:

getFirst in interface List<Byte>

Specified by:

getFirst in interface SequencedCollection<Byte>

getLast

public Byte getLast()

Specified by:

getLast in interface ByteList

Specified by:

getLast in interface ByteSequencedCollection

Specified by:

getLast in interface List<Byte>

Specified by:

getLast in interface SequencedCollection<Byte>

removeFirst

public Byte removeFirst()

Specified by:

removeFirst in interface ByteList

Specified by:

removeFirst in interface ByteSequencedCollection

Specified by:

removeFirst in interface List<Byte>

Specified by:

removeFirst in interface SequencedCollection<Byte>

removeLast

public Byte removeLast()

Specified by:

removeLast in interface ByteList

Specified by:

removeLast in interface ByteSequencedCollection

Specified by:

removeLast in interface List<Byte>

Specified by:

removeLast in interface SequencedCollection<Byte>