Package com.github.tommyettinger.ds

Class ByteDeque

java.lang.Object

com.github.tommyettinger.ds.ByteList

com.github.tommyettinger.ds.ByteDeque

All Implemented Interfaces:

Arrangeable, Ordered.OfByte, PrimitiveCollection<Byte>, PrimitiveCollection.OfByte, RandomAccess

public class ByteDeque
extends ByteList
implements RandomAccess, Arrangeable, PrimitiveCollection.OfByte, Ordered.OfByte

A resizable, insertion-ordered double-ended queue of primitive byte with efficient add and remove at the beginning and end. This extends ByteList and supports RandomAccess. Like ByteList, it is a PrimitiveCollection.OfByte, Arrangeable, and Ordered.OfByte. Values in the backing array may wrap back to the beginning, making add and remove at the beginning and end O(1) (unless the backing array needs to resize when adding). Deque functionality is provided via removeLast() and addFirst(byte).
Unlike most Deque implementations in the JDK, you can get and set items anywhere in the deque in constant time with get(int) and set(int, byte). Relative to a ByteList, get(int) has slightly higher overhead, but it still runs in constant time. Unlike ArrayDeque in the JDK, this implements equals(Object) and hashCode(). This can provide what are effectively ListIterators for iteration from an index or in reverse order.
Unlike ArrayDeque or ArrayList, most methods that take an index here try to be "forgiving;" that is, they treat negative indices as index 0, and too-large indices as the last index, rather than throwing an Exception, except in some cases where the ByteDeque is empty and an item from it is required. An exception is in set(int, byte), which allows prepending by setting a negative index, or appending by setting a too-large index. This isn't a standard JDK behavior, and it doesn't always act how Deque or List is documented.
Some new methods are present here, or have been made public when they weren't before. removeRange(int, int), for instance, is now public, as is resize(int). New APIs include Deque-like methods that affect the middle of the deque, such as peekAt(int) and pollAt(int). There are more bulk methods that work at the head or tail region of the deque, such as addAllFirst(OfByte) and truncateFirst(int). There are the methods from Arrangeable, and many default methods from PrimitiveCollection and Ordered.
In general, this is an improvement over ArrayDeque in every type of functionality, and is mostly equivalent to ByteList as long as the performance of get(int) is adequate. Because it is array-backed, it should usually be much faster than LinkedList, as well; only periodic resizing and modifications in the middle of the List using an iterator should be typically faster for LinkedList.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ByteDeque.ByteDequeIterator	A ByteIterator over the elements of a ByteDeque.

Nested classes/interfaces inherited from class com.github.tommyettinger.ds.ByteList

ByteList.ByteListIterator

Nested classes/interfaces inherited from interface com.github.tommyettinger.ds.Arrangeable

Arrangeable.ArrangeableList<T>

Nested classes/interfaces inherited from interface com.github.tommyettinger.ds.PrimitiveCollection

PrimitiveCollection.OfBoolean, PrimitiveCollection.OfByte, PrimitiveCollection.OfChar, PrimitiveCollection.OfDouble, PrimitiveCollection.OfFloat, PrimitiveCollection.OfInt, PrimitiveCollection.OfLong, PrimitiveCollection.OfShort

Field Summary

Fields

Modifier and Type	Field	Description
byte	defaultValue	The value returned when nothing can be obtained from this deque and an exception is not meant to be thrown, such as when calling peek() on an empty deque.
protected ByteDeque.ByteDequeIterator	descendingIterator1
protected ByteDeque.ByteDequeIterator	descendingIterator2
protected int	head	Index of first element.
protected int	tail	Index of last element.

Fields inherited from class com.github.tommyettinger.ds.ByteList

items, iterator1, iterator2, size

Constructor Summary

Constructors

Constructor	Description
ByteDeque()	Creates a new ByteDeque which can hold 16 values without needing to resize the backing array.
ByteDeque(byte[] a)	Creates a new ByteDeque using all the contents of the given array.
ByteDeque(byte[] a, int offset, int count)	Creates a new ByteDeque using count items from a, starting at offset.
ByteDeque(int initialSize)	Creates a new ByteDeque which can hold the specified number of values without needing to resize the backing array.
ByteDeque(ByteDeque deque)	Copies the given ByteDeque exactly into this one.
ByteDeque(Ordered.OfByte other)
ByteDeque(Ordered.OfByte other, int offset, int count)
ByteDeque(PrimitiveCollection.OfByte coll)	Creates a new ByteDeque using all the contents of the given Collection.
ByteDeque(ByteIterator iter)	Creates a new instance containing the items in the specified iterator.

Method Summary

Modifier and Type	Method	Description
boolean	add(byte t)	Inserts the specified element into the deque represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and throwing an IllegalStateException if no space is currently available.
void	add(byte value1, byte value2)
void	add(byte value1, byte value2, byte value3)
void	add(byte value1, byte value2, byte value3, byte value4)
boolean	addAll(byte[] array)	Exactly like addAll(OfByte), but takes an array instead of a PrimitiveCollection.OfByte.
boolean	addAll(byte[] array, int offset, int length)	Like addAll(byte[]), but only uses at most length items from array, starting at offset.
boolean	addAll(int index, byte[] array)	Like addAll(int, OfByte), but takes an array instead of a PrimitiveCollection.OfByte and inserts it so the first item will be at the given index.
boolean	addAll(int index, byte[] array, int offset, int length)	Like addAll(int, OfByte), but takes an array instead of a PrimitiveCollection.OfByte, gets items starting at offset from that array, using length items, and inserts them so the item at the given offset will be at the given index.
boolean	addAll(int index, Ordered.OfByte ord)	Like addAll(int, OfByte), but takes an ord instead of a PrimitiveCollection.OfByte and inserts it so the first item will be at the given index.
boolean	addAll(int index, Ordered.OfByte ord, int offset, int length)	Like addAll(int, OfByte), but takes an array instead of a PrimitiveCollection.OfByte, gets items starting at offset from that array, using length items, and inserts them so the item at the given offset will be at the given index.
boolean	addAll(int index, PrimitiveCollection.OfByte c)
boolean	addAll(ByteList list)
boolean	addAll(ByteList list, int offset, int count)
boolean	addAll(Ordered.OfByte ord)	Exactly like addAll(OfByte), but takes an Ordered.OfByte instead of a PrimitiveCollection.OfByte.
boolean	addAll(Ordered.OfByte ord, int offset, int length)	Like addAll(byte[]), but only uses at most length items from ord, starting at offset.
boolean	addAll(PrimitiveCollection.OfByte c)	Adds all the elements in the specified collection at the end of this deque, as if by calling addLast(byte) on each one, in the order that they are returned by the collection's iterator.
boolean	addAllFirst(byte[] array)	Exactly like addAllFirst(OfByte), but takes an array instead of a PrimitiveCollection.OfByte.
boolean	addAllFirst(byte[] array, int offset, int length)	Like addAllFirst(byte[]), but only uses at most length items from array, starting at offset.
boolean	addAllFirst(Ordered.OfByte ord)	Exactly like addAllFirst(OfByte), but takes an ord instead of a PrimitiveCollection.OfByte.
boolean	addAllFirst(Ordered.OfByte ord, int offset, int length)	Like addAllFirst(Ordered.OfByte), but only uses at most length items from ord, starting at offset.
boolean	addAllFirst(PrimitiveCollection.OfByte c)	Adds every item in c to this in order at the start.
boolean	addAllLast(byte[] array)	An alias for addAll(byte[]).
boolean	addAllLast(byte[] array, int offset, int length)	An alias for addAll(byte[], int, int).
boolean	addAllLast(Ordered.OfByte ord)	An alias for addAll(Ordered.OfByte).
boolean	addAllLast(Ordered.OfByte ord, int offset, int length)	An alias for addAll(Ordered.OfByte, int, int).
boolean	addAllLast(PrimitiveCollection.OfByte c)	An alias for addAll(OfByte), this adds every item in c to this in order at the end.
void	addFirst(byte value)	Prepend given value to the head (enqueue to head).
void	addFirst(byte value1, byte value2)
void	addFirst(byte value1, byte value2, byte value3)
void	addFirst(byte value1, byte value2, byte value3, byte value4)
void	addLast(byte value)	Appends given byte to the tail (enqueue to tail).
void	addLast(byte value1, byte value2)
void	addLast(byte value1, byte value2, byte value3)
void	addLast(byte value1, byte value2, byte value3, byte value4)
byte	assign(int index, byte item)	Replaces the element at the specified position in this list with the specified element.
void	clear()	Removes all values from this deque.
boolean	contains(byte o)	Returns true if this deque contains the specified element.
boolean	containsAll(ByteList other)	Returns true if this ByteList contains, at least once, every item in other; otherwise returns false.
ByteList.ByteListIterator	descendingIterator()	Returns an iterator over the elements in this deque in reverse sequential order.
ByteList.ByteListIterator	descendingIterator(int index)	Returns an iterator over the elements in this deque in reverse sequential order.
ByteList	div(byte value)	Divides each item in this ByteList by value, stores it in this and returns it.
void	div(int index, byte value)
boolean	duplicateRange(int index, int count)	Inserts the specified number of items at the specified index.
byte	element()	Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque).
byte[]	ensureCapacity(int additional)	Increases the size of the backing array to accommodate the specified number of additional items.
protected int	ensureGap(int index, int gapSize)	Make sure there is a "gap" of exactly gapSize values starting at index.
boolean	equals(Object o)	Using == between each item in order, compares for equality with other subtypes of ByteList.
byte	first()	Returns the first (head) item in the deque (without removing it).
byte	get(int index)	Returns the element at the specified position in this deque.
byte	getDefaultValue()	Gets the default value, which is the value returned when nothing can be obtained from this deque and an exception is not meant to be thrown, such as when calling peek() on an empty deque.
byte	getFirst()	Retrieves, but does not remove, the first element of this deque.
byte	getLast()	Retrieves, but does not remove, the last element of this deque.
byte	getRandom(Random random)	Gets a randomly selected item from this ByteDeque, using the given random number generator.
int	hashCode()
int	indexOf(byte value)	Returns the index of the first occurrence of value in the deque, or -1 if no such value exists.
int	indexOf(byte value, int fromIndex)	Returns the index of the first occurrence of value in the deque, or -1 if no such value exists.
void	insert(int index, byte item)	Inserts the specified element into this deque at the specified index.
boolean	insertAll(int index, byte[] array)	Alias for addAll(int, byte[]).
boolean	insertAll(int index, byte[] array, int offset, int length)	Alias for addAll(int, byte[], int, int).
boolean	insertAll(int index, Ordered.OfByte ord)	Alias for addAll(int, Ordered.OfByte).
boolean	insertAll(int index, Ordered.OfByte ord, int offset, int length)	Alias for addAll(int, Ordered.OfByte, int, int).
boolean	insertAll(int index, PrimitiveCollection.OfByte c)	An alias for addAll(int, OfByte); inserts all elements in the specified collection into this list at the specified position.
boolean	isEmpty()	Returns true if the deque is empty.
ByteList.ByteListIterator	iterator()	Returns an iterator for the items in the deque.
byte	last()	Returns the last (tail) item in the deque (without removing it).
int	lastIndexOf(byte value)	Returns the index of the last occurrence of value in the deque, or -1 if no such value exists.
int	lastIndexOf(byte value, int fromIndex)	Returns the index of last occurrence of value in the deque, starting from fromIndex and going backwards, or -1 if no such value exists.
ByteList.ByteListIterator	listIterator()
ByteList.ByteListIterator	listIterator(int index)	Gets an iterator over this deque that starts at the given index.
ByteList	minus(byte value)	Takes each item in this ByteList and subtracts value, stores it in this and returns it.
void	minus(int index, byte value)
boolean	notEmpty()	Returns true if the deque has one or more items.
boolean	offer(byte t)	Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and false if no space is currently available.
boolean	offerFirst(byte t)	Inserts the specified element at the front of this deque unless it would violate capacity restrictions.
boolean	offerLast(byte t)	Inserts the specified element at the end of this deque unless it would violate capacity restrictions.
ByteDeque	order()	Returns this ByteList, since it is its own order.
static ByteDeque	parse(String str, String delimiter)	Calls parse(String, String, boolean) with brackets set to false.
static ByteDeque	parse(String str, String delimiter, boolean brackets)	Creates a new collection and fills it by calling PrimitiveCollection.OfByte.addLegible(String, String, int, int) on either all of str (if brackets is false) or str without its first and last chars (if brackets is true).
static ByteDeque	parse(String str, String delimiter, int offset, int length)	Creates a new collection and fills it by calling PrimitiveCollection.OfByte.addLegible(String, String, int, int) with the given four parameters as-is.
byte	peek()	Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque), or returns defaultValue if this deque is empty.
byte	peekAt(int index)	Returns the element at the specified position in this deque.
byte	peekFirst()	Retrieves, but does not remove, the first element of this deque, or returns defaultValue if this deque is empty.
byte	peekLast()	Retrieves, but does not remove, the last element of this deque, or returns defaultValue if this deque is empty.
ByteList	plus(byte value)	Adds value to each item in this ByteList, stores it in this and returns it.
void	plus(int index, byte value)
byte	poll()	Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returns defaultValue if this deque is empty.
byte	poll(int index)	Removes the element at the specified position in this deque.
byte	pollAt(int index)	Removes the element at the specified position in this deque.
byte	pollFirst()	Retrieves and removes the first element of this deque, or returns defaultValue if this deque is empty.
byte	pollLast()	Retrieves and removes the last element of this deque, or returns defaultValue if this deque is empty.
byte	pop()	Pops an element from the stack represented by this deque.
void	push(byte t)	Pushes an element onto the stack represented by this deque (in other words, at the head of this deque).
byte	random(Random random)	Gets a randomly selected item from this ByteDeque, using the given random number generator.
ByteList	rem(byte value)	Gets the remainder of each item in this ByteList with value, stores it in this and returns it.
void	rem(int index, byte value)
byte	remove()	Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque).
boolean	remove(byte o)	Removes the first occurrence of the specified element from this deque.
boolean	removeAll(PrimitiveCollection.OfByte c)	Removes from this ByteList all occurrences of any elements contained in the specified collection.
byte	removeAt(int index)	Removes the element at the specified position in this deque.
boolean	removeEach(PrimitiveCollection.OfByte c)	Removes from this ByteList element-wise occurrences of elements contained in the specified collection.
byte	removeFirst()	Remove the first item from the deque.
boolean	removeFirstOccurrence(byte o)	Removes the first occurrence of the specified element from this deque.
byte	removeLast()	Remove the last item from the deque.
boolean	removeLastOccurrence(byte o)	Removes the last occurrence of the specified element from this deque.
boolean	removeLastValue(byte value)	Removes the last instance of the specified value in the deque.
void	removeRange(int fromIndex, int toIndex)	Removes from this list all the elements whose index is between fromIndex, inclusive, and toIndex, exclusive.
boolean	removeValue(byte value)	Removes the first instance of the specified value in the deque.
int	replaceAll(byte find, byte replace)	Replaces every occurrence of find with replace.
void	replaceAll(com.github.tommyettinger.function.ByteToByteFunction operator)	Replaces each element of this list with the result of applying the given operator to that element.
boolean	replaceFirst(byte find, byte replace)	Replaces the first occurrence of find with replace.
byte[]	resize(int newSize)	Resizes the backing array.
boolean	retainAll(PrimitiveCollection.OfByte other)	Removes all items from this ByteList that are not present somewhere in other, any number of times.
void	reverse()	Reverses this ByteDeque in-place.
void	set(int index, byte item)	Replaces the element at the specified position in this list with the specified element.
void	setDefaultValue(byte defaultValue)	Sets the default value, which is the value returned when nothing can be obtained from this deque and an exception is not meant to be thrown, such as when calling peek() on an empty deque.
byte[]	setSize(int newSize)	Sets the list size, leaving any values beyond the current size undefined.
byte[]	shrink()	Reduces the size of the backing array to the size of the actual items.
void	shuffle(Random rng)	Pseudo-randomly shuffles the order of this Ordered in-place.
int	size()	Returns the number of elements in this deque.
void	sort()	Sorts this deque in-place using Arrays.sort(byte[], int, int) in ascending order.
void	sort(int from, int to)	Uses Arrays.sort(byte[], int, int) to sort a (clamped) subrange of this deque.
void	sort(int from, int to, ByteComparator comparator)	Sorts the specified range of elements according to the order induced by the specified comparator using mergesort, or Arrays.sort(byte[], int, int) if c is null.
void	sort(ByteComparator comparator)	Sorts this deque in-place using ByteComparators.sort(byte[], int, int, ByteComparator).
void	swap(int first, int second)	Switches the ordering of positions first and second, without changing any items beyond that.
ByteList	times(byte value)	Multiplies each item in this ByteList by value, stores it in this and returns it.
void	times(int index, byte value)
byte[]	toArray()	Returns an array containing all the elements in this collection.
byte[]	toArray(byte[] array)	If array.length at least equal to ByteList.size(), this copies the contents of this into array and returns it; otherwise, it allocates a new byte array that can fit all the items in this, and proceeds to copy into that and return that.
String	toString()	Delegates to PrimitiveCollection.OfByte.toString(String, boolean) with a delimiter of ", " and square brackets enabled.
void	trimToSize()	Trims the capacity of this ByteDeque instance to be the deque's current size.
void	truncate(int newSize)	Reduces the size of the deque to the specified size by bulk-removing items from the tail end.
void	truncateFirst(int newSize)	Reduces the size of the deque to the specified size by bulk-removing from the head.
void	truncateLast(int newSize)	Alias for truncate(int).
static ByteDeque	with()	Constructs an empty deque.
static ByteDeque	with(byte item)	Creates a new ByteDeque that holds only the given item, but can be resized.
static ByteDeque	with(byte... varargs)	Creates a new ByteDeque that will hold the items in the given array or varargs.
static ByteDeque	with(byte item0, byte item1)	Creates a new ByteDeque that holds only the given items, but can be resized.
static ByteDeque	with(byte item0, byte item1, byte item2)	Creates a new ByteDeque that holds only the given items, but can be resized.
static ByteDeque	with(byte item0, byte item1, byte item2, byte item3)	Creates a new ByteDeque that holds only the given items, but can be resized.
static ByteDeque	with(byte item0, byte item1, byte item2, byte item3, byte item4)	Creates a new ByteDeque that holds only the given items, but can be resized.
static ByteDeque	with(byte item0, byte item1, byte item2, byte item3, byte item4, byte item5)	Creates a new ByteDeque that holds only the given items, but can be resized.
static ByteDeque	with(byte item0, byte item1, byte item2, byte item3, byte item4, byte item5, byte item6)	Creates a new ByteDeque that holds only the given items, but can be resized.
static ByteDeque	with(byte item0, byte item1, byte item2, byte item3, byte item4, byte item5, byte item6, byte item7)	Creates a new ByteDeque that holds only the given items, but can be resized.

Methods inherited from class com.github.tommyettinger.ds.ByteList

keepsOrder

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.tommyettinger.ds.Arrangeable

rearrange, shuffle

Methods inherited from interface com.github.tommyettinger.ds.Ordered.OfByte

getOrderType, random, selectRanked, selectRankedIndex

Methods inherited from interface com.github.tommyettinger.ds.PrimitiveCollection.OfByte

addAll, addDense, addDense, addLegible, addLegible, addVarargs, appendTo, appendTo, containsAll, containsAll, containsAll, containsAll, containsAny, containsAny, containsAny, containsAny, denseAppendTo, forEach, removeAll, removeAll, removeAll, removeEach, removeEach, removeEach, removeIf, retainAll, retainAll, toDenseString, toDenseString, toString, toString, toString

Field Details

defaultValue

public byte defaultValue

The value returned when nothing can be obtained from this deque and an exception is not meant to be thrown, such as when calling peek() on an empty deque.

head

protected int head

Index of first element. Logically smaller than tail. Unless empty, it points to a valid element inside the deque.

tail

protected int tail

Index of last element. Logically bigger than head. Unless empty, it points to a valid element inside the deque. This may be the same as head, and is if there is one element in the deque (or none), that will be the case.

descendingIterator1

protected transient ByteDeque.ByteDequeIterator descendingIterator1

descendingIterator2

protected transient ByteDeque.ByteDequeIterator descendingIterator2

Constructor Details

ByteDeque

public ByteDeque()

Creates a new ByteDeque which can hold 16 values without needing to resize the backing array.

ByteDeque

public ByteDeque(int initialSize)

Creates a new ByteDeque which can hold the specified number of values without needing to resize the backing array.

Parameters:

initialSize - how large the backing array should be, without any padding

ByteDeque

public ByteDeque(PrimitiveCollection.OfByte coll)

Creates a new ByteDeque using all the contents of the given Collection.

Parameters:

coll - a Collection of byte that will be copied into this and used in full

Throws:

NullPointerException - if coll is null

ByteDeque

public ByteDeque(ByteIterator iter)

Creates a new instance containing the items in the specified iterator.

Parameters:

iter - an iterator that will have its remaining contents added to this

Throws:

NullPointerException - if iter is null

ByteDeque

public ByteDeque(ByteDeque deque)

Copies the given ByteDeque exactly into this one. Individual values will be shallow-copied.

Parameters:

deque - another ByteDeque to copy

Throws:

NullPointerException - if deque is null

ByteDeque

public ByteDeque(Ordered.OfByte other,
 int offset,
 int count)

ByteDeque

public ByteDeque(byte[] a)

Creates a new ByteDeque using all the contents of the given array.

Parameters:

a - an array of byte that will be copied into this and used in full

Throws:

NullPointerException - if a is null

ByteDeque

public ByteDeque(byte[] a,
 int offset,
 int count)

Creates a new ByteDeque using count items from a, starting at offset. If count is 0 or less, this will create an empty ByteDeque with capacity 1.

Parameters:

a - an array of byte

offset - where in a to start using items

count - how many items to use from a

Throws:

NullPointerException - if a is null

ByteDeque

public ByteDeque(Ordered.OfByte other)

Method Details

order

public ByteDeque order()

Description copied from class: ByteList

Returns this ByteList, since it is its own order. This is only here to satisfy the Ordered.OfByte interface.

Specified by:

order in interface Ordered.OfByte

Overrides:

order in class ByteList

Returns:

this ByteList

getDefaultValue

public byte getDefaultValue()

Gets the default value, which is the value returned when nothing can be obtained from this deque and an exception is not meant to be thrown, such as when calling peek() on an empty deque. Unless changed, the default value is usually null.

Returns:

the current default value

setDefaultValue

public void setDefaultValue(byte defaultValue)

Sets the default value, which is the value returned when nothing can be obtained from this deque and an exception is not meant to be thrown, such as when calling peek() on an empty deque. Unless changed, the default value is usually null.

Parameters:

defaultValue - any byte this can return instead of throwing an Exception, or null

addLast

public void addLast(byte value)

Appends given byte to the tail (enqueue to tail). Unless the backing array needs resizing, operates in O(1) time.

Parameters:

value - can be null

addLast

public void addLast(byte value1,
 byte value2)

addLast

public void addLast(byte value1,
 byte value2,
 byte value3)

addLast

public void addLast(byte value1,
 byte value2,
 byte value3,
 byte value4)

addFirst

public void addFirst(byte value)

Prepend given value to the head (enqueue to head). Unless backing array needs resizing, operates in O(1) time.

Parameters:

value - can be null

See Also:

• addLast(byte)

addFirst

public void addFirst(byte value1,
 byte value2)

addFirst

public void addFirst(byte value1,
 byte value2,
 byte value3)

addFirst

public void addFirst(byte value1,
 byte value2,
 byte value3,
 byte value4)

trimToSize

public void trimToSize()

Trims the capacity of this ByteDeque instance to be the deque's current size. An application can use this operation to minimize the storage of a ByteDeque instance.

Overrides:

trimToSize in class ByteList

shrink

public byte[] shrink()

Description copied from class: ByteList

Reduces the size of the backing array to the size of the actual items. This is useful to release memory when many items have been removed, or if it is known that more items will not be added.

Overrides:

shrink in class ByteList

Returns:

ByteList.items; this will be a different reference if this resized

ensureCapacity

public byte[] ensureCapacity(int additional)

Increases the size of the backing array to accommodate the specified number of additional items. Useful before adding many items to avoid multiple backing array resizes.

Overrides:

ensureCapacity in class ByteList

Returns:

the backing array this will use after this call

resize

public byte[] resize(int newSize)

Resizes the backing array. newSize should be greater than the current size; otherwise, newSize will be set to size and the resize to the same size will (for most purposes) be wasted effort. If this is not empty, this will rearrange the items internally to be linear and have the head at index 0, with the tail at size - 1. This always allocates a new internal backing array.

Overrides:

resize in class ByteList

Returns:

the new backing array, as a direct reference

ensureGap

protected int ensureGap(int index,
 int gapSize)

Make sure there is a "gap" of exactly gapSize values starting at index. This can resize the backing array to achieve this goal. If possible, this will keep the same backing array and modify it in-place. The "gap" is not assigned null, and may contain old/duplicate references; calling code must overwrite the entire gap with additional values to ensure GC correctness.

Parameters:

index - the 0-based index in the iteration order where the gap will be present

gapSize - the number of items that will need filling in the gap, and can be filled without issues.

Returns:

the position in the array where the gap will begin, which is unrelated to the index

addAll

public boolean addAll(ByteList list)

Overrides:

addAll in class ByteList

addAll

public boolean addAll(ByteList list,
 int offset,
 int count)

Overrides:

addAll in class ByteList

removeFirst

public byte removeFirst()

Remove the first item from the deque. (dequeue from head) Always O(1).

Returns:

removed byte

Throws:

NoSuchElementException - when the deque is empty

removeLast

public byte removeLast()

Remove the last item from the deque. (dequeue from tail) Always O(1).

Returns:

removed byte

Throws:

NoSuchElementException - when the deque is empty

See Also:

• removeFirst()

offerFirst

public boolean offerFirst(byte t)

Inserts the specified element at the front of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the addFirst(byte) method, which can fail to insert an element only by throwing an exception.

Parameters:

t - the element to add

Returns:

true if the element was added to this deque, else false

Throws:

ClassCastException - if the class of the specified element prevents it from being added to this deque

NullPointerException - if the specified element is null and this deque does not permit null elements

IllegalArgumentException - if some property of the specified element prevents it from being added to this deque

offerLast

public boolean offerLast(byte t)

Inserts the specified element at the end of this deque unless it would violate capacity restrictions. When using a capacity-restricted deque, this method is generally preferable to the addLast(byte) method, which can fail to insert an element only by throwing an exception.

Parameters:

t - the element to add

Returns:

true if the element was added to this deque, else false

Throws:

ClassCastException - if the class of the specified element prevents it from being added to this deque

NullPointerException - if the specified element is null and this deque does not permit null elements

IllegalArgumentException - if some property of the specified element prevents it from being added to this deque

pollFirst

public byte pollFirst()

Retrieves and removes the first element of this deque, or returns defaultValue if this deque is empty. The default value is usually null unless it has been changed with setDefaultValue(byte).

Returns:

the head of this deque, or defaultValue if this deque is empty

See Also:

• the alternative removeFirst() throws an Exception if the deque is empty

pollLast

public byte pollLast()

Retrieves and removes the last element of this deque, or returns defaultValue if this deque is empty. The default value is usually null unless it has been changed with setDefaultValue(byte).

Returns:

the tail of this deque, or defaultValue if this deque is empty

See Also:

• the alternative removeLast() throws an Exception if the deque is empty

getFirst

public byte getFirst()

Retrieves, but does not remove, the first element of this deque.

This method differs from peekFirst only in that it throws an exception if this deque is empty.

Returns:

the head of this deque

Throws:

NoSuchElementException - if this deque is empty

getLast

public byte getLast()

Retrieves, but does not remove, the last element of this deque. This method differs from peekLast only in that it throws an exception if this deque is empty.

Returns:

the tail of this deque

Throws:

NoSuchElementException - if this deque is empty

peekFirst

public byte peekFirst()

Retrieves, but does not remove, the first element of this deque, or returns defaultValue if this deque is empty.

Returns:

the head of this deque, or defaultValue if this deque is empty

peekLast

public byte peekLast()

Retrieves, but does not remove, the last element of this deque, or returns defaultValue if this deque is empty.

Returns:

the tail of this deque, or defaultValue if this deque is empty

removeFirstOccurrence

public boolean removeFirstOccurrence(byte o)

Removes the first occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the first element e such that o == e (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).

Parameters:

o - element to be removed from this deque, if present

Returns:

true if an element was removed as a result of this call

removeLastOccurrence

public boolean removeLastOccurrence(byte o)

Removes the last occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the last element e such that o == e (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).

Parameters:

o - element to be removed from this deque, if present

Returns:

true if an element was removed as a result of this call

add

public boolean add(byte t)

Inserts the specified element into the deque represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and throwing an IllegalStateException if no space is currently available. When using a capacity-restricted deque, it is generally preferable to use offer.

This method is equivalent to addLast(byte).

Specified by:

add in interface PrimitiveCollection.OfByte

Overrides:

add in class ByteList

Parameters:

t - the element to add

Returns:

true (as specified by Collection.add(E))

add

public void add(byte value1,
 byte value2)

Overrides:

add in class ByteList

add

public void add(byte value1,
 byte value2,
 byte value3)

Overrides:

add in class ByteList

add

public void add(byte value1,
 byte value2,
 byte value3,
 byte value4)

Overrides:

add in class ByteList

insert

public void insert(int index,
 byte item)

Inserts the specified element into this deque at the specified index. Unlike offerFirst(byte) and offerLast(byte), this does not run in expected constant time unless the index is less than or equal to 0 (where it acts like offerFirst()) or greater than or equal to size() (where it acts like offerLast()).

Overrides:

insert in class ByteList

Parameters:

index - the index in the deque's insertion order to insert the item

item - a byte item to insert; may be null

offer

public boolean offer(byte t)

Inserts the specified element into the queue represented by this deque (in other words, at the tail of this deque) if it is possible to do so immediately without violating capacity restrictions, returning true upon success and false if no space is currently available. When using a capacity-restricted deque, this method is generally preferable to the add(byte) method, which can fail to insert an element only by throwing an exception.

This method is equivalent to offerLast(byte).

Parameters:

t - the element to add

Returns:

true if the element was added to this deque, else false

remove

public byte remove()

Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from poll() only in that it throws an exception if this deque is empty.

This method is equivalent to removeFirst().

Returns:

the head of the queue represented by this deque

Throws:

NoSuchElementException - if this deque is empty

poll

public byte poll()

Retrieves and removes the head of the queue represented by this deque (in other words, the first element of this deque), or returns defaultValue if this deque is empty.

This method is equivalent to pollFirst().

Returns:

the first element of this deque, or defaultValue if this deque is empty

element

public byte element()

Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque). This method differs from peek only in that it throws an exception if this deque is empty.

This method is equivalent to getFirst().

Returns:

the head of the queue represented by this deque

Throws:

NoSuchElementException - if this deque is empty

peek

public byte peek()

Retrieves, but does not remove, the head of the queue represented by this deque (in other words, the first element of this deque), or returns defaultValue if this deque is empty.

This method is equivalent to peekFirst().

Overrides:

peek in class ByteList

Returns:

the head of the queue represented by this deque, or defaultValue if this deque is empty

addAll

public boolean addAll(PrimitiveCollection.OfByte c)

Adds all the elements in the specified collection at the end of this deque, as if by calling addLast(byte) on each one, in the order that they are returned by the collection's iterator.

When using a capacity-restricted deque, it is generally preferable to call offer separately on each element.

An exception encountered while trying to add an element may result in only some of the elements having been successfully added when the associated exception is thrown.

Specified by:

addAll in interface PrimitiveCollection.OfByte

Parameters:

c - the elements to be inserted into this deque

Returns:

true if this deque changed as a result of the call

addAllLast

public boolean addAllLast(PrimitiveCollection.OfByte c)

An alias for addAll(OfByte), this adds every item in c to this in order at the end.

Parameters:

c - the elements to be inserted into this deque

Returns:

true if this deque changed as a result of the call

addAllFirst

public boolean addAllFirst(PrimitiveCollection.OfByte c)

Adds every item in c to this in order at the start. The iteration order of c will be preserved for the added items.

Parameters:

c - the elements to be inserted into this deque

Returns:

true if this deque changed as a result of the call

insertAll

public boolean insertAll(int index,
 PrimitiveCollection.OfByte c)

An alias for addAll(int, OfByte); inserts all elements in the specified collection into this list at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)

Parameters:

index - index at which to insert the first element from the specified collection

c - collection containing elements to be added to this list

Returns:

true if this list changed as a result of the call

addAll

public boolean addAll(int index,
 PrimitiveCollection.OfByte c)

addAll

public boolean addAll(byte[] array)

Exactly like addAll(OfByte), but takes an array instead of a PrimitiveCollection.OfByte.

Specified by:

addAll in interface PrimitiveCollection.OfByte

Overrides:

addAll in class ByteList

Parameters:

array - the elements to be inserted into this deque

Returns:

true if this deque changed as a result of the call

See Also:

• addAll(OfByte)

addAll

public boolean addAll(byte[] array,
 int offset,
 int length)

Like addAll(byte[]), but only uses at most length items from array, starting at offset.

Specified by:

addAll in interface PrimitiveCollection.OfByte

Overrides:

addAll in class ByteList

Parameters:

array - the elements to be inserted into this deque

offset - the index of the first item in array to add

length - how many items, at most, to add from array into this

Returns:

true if this deque changed as a result of the call

See Also:

• addAll(byte[])

addAllLast

public boolean addAllLast(byte[] array)

An alias for addAll(byte[]).

Parameters:

array - the elements to be inserted into this deque

Returns:

true if this deque changed as a result of the call

See Also:

• addAll(byte[])

addAllLast

public boolean addAllLast(byte[] array,
 int offset,
 int length)

An alias for addAll(byte[], int, int).

Parameters:

array - the elements to be inserted into this deque

offset - the index of the first item in array to add

length - how many items, at most, to add from array into this

Returns:

true if this deque changed as a result of the call

See Also:

• addAll(byte[], int, int)

addAllFirst

public boolean addAllFirst(byte[] array)

Exactly like addAllFirst(OfByte), but takes an array instead of a PrimitiveCollection.OfByte.

Parameters:

array - the elements to be inserted into this deque

Returns:

true if this deque changed as a result of the call

See Also:

• addAllFirst(OfByte)

addAllFirst

public boolean addAllFirst(byte[] array,
 int offset,
 int length)

Like addAllFirst(byte[]), but only uses at most length items from array, starting at offset. The order of array will be preserved, starting at the head of the deque.

Parameters:

array - the elements to be inserted into this deque

offset - the index of the first item in array to add

length - how many items, at most, to add from array into this

Returns:

true if this deque changed as a result of the call

See Also:

• addAllFirst(byte[])

insertAll

public boolean insertAll(int index,
 byte[] array)

Alias for addAll(int, byte[]).

Parameters:

index - the index in this deque's iteration order to place the first item in array

array - the elements to be inserted into this deque

Returns:

true if this deque changed as a result of the call

insertAll

public boolean insertAll(int index,
 byte[] array,
 int offset,
 int length)

Alias for addAll(int, byte[], int, int).

Parameters:

index - the index in this deque's iteration order to place the first item in array

array - the elements to be inserted into this deque

offset - the index of the first item in array to add

length - how many items, at most, to add from array into this

Returns:

true if this deque changed as a result of the call

addAll

public boolean addAll(int index,
 byte[] array)

Like addAll(int, OfByte), but takes an array instead of a PrimitiveCollection.OfByte and inserts it so the first item will be at the given index. The order of array will be preserved, starting at the given index in this deque.

Parameters:

index - the index in this deque's iteration order to place the first item in array

array - the elements to be inserted into this deque

Returns:

true if this deque changed as a result of the call

See Also:

• addAll(byte[])

addAll

public boolean addAll(int index,
 byte[] array,
 int offset,
 int length)

Like addAll(int, OfByte), but takes an array instead of a PrimitiveCollection.OfByte, gets items starting at offset from that array, using length items, and inserts them so the item at the given offset will be at the given index. The order of array will be preserved, starting at the given index in this deque.

Parameters:

index - the index in this deque's iteration order to place the first item in array

array - the elements to be inserted into this deque

offset - the index of the first item in array to add

length - how many items, at most, to add from array into this

Returns:

true if this deque changed as a result of the call

See Also:

• addAll(byte[])

addAll

public boolean addAll(Ordered.OfByte ord)

Exactly like addAll(OfByte), but takes an Ordered.OfByte instead of a PrimitiveCollection.OfByte.

Parameters:

ord - the elements to be inserted into this deque

Returns:

true if this deque changed as a result of the call

See Also:

• addAll(OfByte)

addAll

public boolean addAll(Ordered.OfByte ord,
 int offset,
 int length)

Like addAll(byte[]), but only uses at most length items from ord, starting at offset.

Overrides:

addAll in class ByteList

Parameters:

ord - the elements to be inserted into this deque

offset - the index of the first item in ord to add

length - how many items, at most, to add from ord into this

Returns:

true if this deque changed as a result of the call

See Also:

• addAll(byte[])

addAll

public boolean addAll(int index,
 Ordered.OfByte ord)

Like addAll(int, OfByte), but takes an ord instead of a PrimitiveCollection.OfByte and inserts it so the first item will be at the given index. The order of ord will be preserved, starting at the given index in this deque.

Parameters:

index - the index in this deque's iteration order to place the first item in ord

ord - the elements to be inserted into this deque

Returns:

true if this deque changed as a result of the call

See Also:

• addAll(Ordered.OfByte)

addAll

public boolean addAll(int index,
 Ordered.OfByte ord,
 int offset,
 int length)

Like addAll(int, OfByte), but takes an array instead of a PrimitiveCollection.OfByte, gets items starting at offset from that array, using length items, and inserts them so the item at the given offset will be at the given index. The order of array will be preserved, starting at the given index in this deque.

Overrides:

addAll in class ByteList

Parameters:

index - the index in this deque's iteration order to place the first item in array

ord - the elements to be inserted into this deque

offset - the index of the first item in array to add

length - how many items, at most, to add from array into this

Returns:

true if this deque changed as a result of the call

See Also:

• addAll(Ordered.OfByte)

addAllLast

public boolean addAllLast(Ordered.OfByte ord)

An alias for addAll(Ordered.OfByte).

Parameters:

ord - the elements to be inserted into this deque

Returns:

true if this deque changed as a result of the call

See Also:

• addAll(Ordered.OfByte)

addAllLast

public boolean addAllLast(Ordered.OfByte ord,
 int offset,
 int length)

An alias for addAll(Ordered.OfByte, int, int).

Parameters:

ord - the elements to be inserted into this deque

offset - the index of the first item in ord to add

length - how many items, at most, to add from ord into this

Returns:

true if this deque changed as a result of the call

See Also:

• addAll(Ordered.OfByte, int, int)

addAllFirst

public boolean addAllFirst(Ordered.OfByte ord)

Exactly like addAllFirst(OfByte), but takes an ord instead of a PrimitiveCollection.OfByte.

Parameters:

ord - the elements to be inserted into this deque

Returns:

true if this deque changed as a result of the call

See Also:

• addAllFirst(OfByte)

addAllFirst

public boolean addAllFirst(Ordered.OfByte ord,
 int offset,
 int length)

Like addAllFirst(Ordered.OfByte), but only uses at most length items from ord, starting at offset. The order of ord will be preserved, starting at the head of the deque.

Parameters:

ord - the elements to be inserted into this deque

offset - the index of the first item in ord to add

length - how many items, at most, to add from ord into this

Returns:

true if this deque changed as a result of the call

See Also:

• addAllFirst(Ordered.OfByte)

insertAll

public boolean insertAll(int index,
 Ordered.OfByte ord)

Alias for addAll(int, Ordered.OfByte).

Parameters:

index - the index in this deque's iteration order to place the first item in ord

ord - the elements to be inserted into this deque

Returns:

true if this deque changed as a result of the call

insertAll

public boolean insertAll(int index,
 Ordered.OfByte ord,
 int offset,
 int length)

Alias for addAll(int, Ordered.OfByte, int, int).

Parameters:

index - the index in this deque's iteration order to place the first item in ord

ord - the elements to be inserted into this deque

offset - the index of the first item in ord to add

length - how many items, at most, to add from ord into this

Returns:

true if this deque changed as a result of the call

push

public void push(byte t)

Pushes an element onto the stack represented by this deque (in other words, at the head of this deque).

This method is equivalent to addFirst(byte).

Parameters:

t - the element to push

pop

public byte pop()

Pops an element from the stack represented by this deque. In other words, removes and returns the first element of this deque.

This method is equivalent to removeFirst().

Overrides:

pop in class ByteList

Returns:

the element at the front of this deque (which is the top of the stack represented by this deque)

Throws:

NoSuchElementException - if this deque is empty

remove

public boolean remove(byte o)

Removes the first occurrence of the specified element from this deque. If the deque does not contain the element, it is unchanged. More formally, removes the first element e such that o == e (if such an element exists). Returns true if this deque contained the specified element (or equivalently, if this deque changed as a result of the call).

This method is equivalent to removeFirstOccurrence(byte).

Specified by:

remove in interface PrimitiveCollection.OfByte

Overrides:

remove in class ByteList

Parameters:

o - element to be removed from this deque, if present

Returns:

true if an element was removed as a result of this call

contains

public boolean contains(byte o)

Returns true if this deque contains the specified element. More formally, returns true if and only if this deque contains at least one element e such that o == e.

Specified by:

contains in interface PrimitiveCollection.OfByte

Overrides:

contains in class ByteList

Parameters:

o - element whose presence in this deque is to be tested

Returns:

true if this deque contains the specified element

containsAll

public boolean containsAll(ByteList other)

Description copied from class: ByteList

Returns true if this ByteList contains, at least once, every item in other; otherwise returns false.

Overrides:

containsAll in class ByteList

Parameters:

other - an ByteList

Returns:

true if this contains every item in other, otherwise false

size

public int size()

Returns the number of elements in this deque.

Specified by:

size in interface Arrangeable

Specified by:

size in interface PrimitiveCollection<Byte>

Overrides:

size in class ByteList

Returns:

the number of elements in this deque

toArray

public byte[] toArray()

Returns an array containing all the elements in this collection. If this collection makes any guarantees as to what order its elements are returned by its iterator, this method must return the elements in the same order. The returned array's runtime component type is byte.

The returned array will be "safe" in that no references to it are maintained by this collection. (In other words, this method must allocate a new array even if this collection is backed by an array). The caller is thus free to modify the returned array.

Specified by:

toArray in interface PrimitiveCollection.OfByte

Overrides:

toArray in class ByteList

Returns:

an array, whose runtime component type is byte, containing all the elements in this collection

toArray

public byte[] toArray(byte[] array)

Description copied from class: ByteList

If array.length at least equal to ByteList.size(), this copies the contents of this into array and returns it; otherwise, it allocates a new byte array that can fit all the items in this, and proceeds to copy into that and return that.

Specified by:

toArray in interface PrimitiveCollection.OfByte

Overrides:

toArray in class ByteList

Parameters:

array - a byte array that will be modified if it can fit ByteList.size() items

Returns:

array, if it had sufficient size, or a new array otherwise, either with a copy of this

setSize

public byte[] setSize(int newSize)

Description copied from class: ByteList

Sets the list size, leaving any values beyond the current size undefined.

Overrides:

setSize in class ByteList

Returns:

ByteList.items; this will be a different reference if this resized to a larger capacity

truncateLast

public void truncateLast(int newSize)

Alias for truncate(int).

Parameters:

newSize - the size this deque should have after this call completes, if smaller than the current size

truncate

public void truncate(int newSize)

Reduces the size of the deque to the specified size by bulk-removing items from the tail end. If the deque is already smaller than the specified size, no action is taken.

Overrides:

truncate in class ByteList

Parameters:

newSize - the size this deque should have after this call completes, if smaller than the current size

truncateFirst

public void truncateFirst(int newSize)

Reduces the size of the deque to the specified size by bulk-removing from the head. If the deque is already smaller than the specified size, no action is taken.

Parameters:

newSize - the size this deque should have after this call completes, if smaller than the current size

removeRange

public void removeRange(int fromIndex,
 int toIndex)

Removes from this list all the elements whose index is between fromIndex, inclusive, and toIndex, exclusive. Shifts any succeeding elements to the left (reduces their index). This call shrinks the list by (toIndex - fromIndex) elements. If toIndex==fromIndex, this operation has no effect. If fromIndex is 0 or less, this delegates to truncateFirst(int); if toIndex is equal to or greater than the size of this collection, this delegates to truncate(int).
This is public here, not protected as in most JDK collections, because there are actually sometimes needs for this in user code.

Specified by:

removeRange in interface Ordered.OfByte

Overrides:

removeRange in class ByteList

Parameters:

fromIndex - index of first element to be removed (inclusive)

toIndex - index after last element to be removed (exclusive)

indexOf

public int indexOf(byte value)

Returns the index of the first occurrence of value in the deque, or -1 if no such value exists.

Overrides:

indexOf in class ByteList

Parameters:

value - the byte to look for

Returns:

An index of the first occurrence of value in the deque or -1 if no such value exists

indexOf

public int indexOf(byte value,
 int fromIndex)

Returns the index of the first occurrence of value in the deque, or -1 if no such value exists. This returns fromIndex if value is present at that point, so if you chain calls to indexOf(), the subsequent fromIndex should be larger than the last-returned index.

Parameters:

value - the byte to look for

fromIndex - the initial index to check (zero-indexed, starts at the head, inclusive)

Returns:

An index of first occurrence of value at or after fromIndex in the deque, or -1 if no such value exists

lastIndexOf

public int lastIndexOf(byte value)

Returns the index of the last occurrence of value in the deque, or -1 if no such value exists.

Overrides:

lastIndexOf in class ByteList

Parameters:

value - the byte to look for

Returns:

An index of the last occurrence of value in the deque or -1 if no such value exists

lastIndexOf

public int lastIndexOf(byte value,
 int fromIndex)

Returns the index of last occurrence of value in the deque, starting from fromIndex and going backwards, or -1 if no such value exists. This returns fromIndex if value is present at that point, so if you chain calls to indexOf(), the subsequent fromIndex should be smaller than the last-returned index.

Parameters:

value - the byte to look for

fromIndex - the initial index to check (zero-indexed, starts at the head, inclusive)

Returns:

An index of last occurrence of value at or before fromIndex in the deque, or -1 if no such value exists

listIterator

public ByteList.ByteListIterator listIterator()

listIterator

public ByteList.ByteListIterator listIterator(int index)

Gets an iterator over this deque that starts at the given index.

Parameters:

index - the index to start iterating from in this deque

Returns:

a reused iterator starting at the given index

removeValue

public boolean removeValue(byte value)

Removes the first instance of the specified value in the deque.

Parameters:

value - the byte to remove

Returns:

true if value was found and removed, false otherwise

removeLastValue

public boolean removeLastValue(byte value)

Removes the last instance of the specified value in the deque.

Parameters:

value - the byte to remove

Returns:

true if value was found and removed, false otherwise

removeAt

public byte removeAt(int index)

Removes the element at the specified position in this deque. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the deque.

Overrides:

removeAt in class ByteList

Parameters:

index - the index of the element to be removed

Returns:

the element previously at the specified position

pollAt

public byte pollAt(int index)

Removes the element at the specified position in this deque. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the deque, or the default value if this is empty. This will not throw an Exception in normal usage, even if index is negative (which makes this simply return pollFirst()) or greater than or equal to size() (which makes this return pollLast()).
This is an alias for poll(int) for compatibility with primitive-backed lists and deques; poll(int) can refer to the method that removes an item by value, not by index, in those types.

Parameters:

index - the index of the element to be removed

Returns:

the element previously at the specified position

poll

public byte poll(int index)

Removes the element at the specified position in this deque. Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the deque, or the default value if this is empty. This will not throw an Exception in normal usage, even if index is negative (which makes this simply return pollFirst()) or greater than or equal to size() (which makes this return pollLast()).

Parameters:

index - the index of the element to be removed

Returns:

the element previously at the specified position

removeAll

public boolean removeAll(PrimitiveCollection.OfByte c)

Description copied from class: ByteList

Removes from this ByteList all occurrences of any elements contained in the specified collection.

Specified by:

removeAll in interface PrimitiveCollection.OfByte

Overrides:

removeAll in class ByteList

Parameters:

c - a primitive collection of int items to remove fully, such as another ByteList or a ByteDeque

Returns:

true if this list was modified.

removeEach

public boolean removeEach(PrimitiveCollection.OfByte c)

Description copied from class: ByteList

Removes from this ByteList element-wise occurrences of elements contained in the specified collection. Note that if a value is present more than once in this ByteList, only one of those occurrences will be removed for each occurrence of that value in c. If c has the same contents as this ByteList or has additional items, then removing each of c will clear this.

Specified by:

removeEach in interface PrimitiveCollection.OfByte

Overrides:

removeEach in class ByteList

Parameters:

c - a primitive collection of int items to remove one-by-one, such as another ByteList or a ByteDeque

Returns:

true if this list was modified.

retainAll

public boolean retainAll(PrimitiveCollection.OfByte other)

Description copied from class: ByteList

Removes all items from this ByteList that are not present somewhere in other, any number of times.

Specified by:

retainAll in interface PrimitiveCollection.OfByte

Overrides:

retainAll in class ByteList

Parameters:

other - a PrimitiveCollection.OfByte that contains the items that this should keep, whenever present

Returns:

true if this ByteList changed as a result of this call, otherwise false

notEmpty

public boolean notEmpty()

Returns true if the deque has one or more items.

Specified by:

notEmpty in interface PrimitiveCollection<Byte>

Overrides:

notEmpty in class ByteList

Returns:

true if the list has one or more items, or false otherwise

isEmpty

public boolean isEmpty()

Returns true if the deque is empty.

Specified by:

isEmpty in interface PrimitiveCollection<Byte>

Overrides:

isEmpty in class ByteList

Returns:

true if the list is empty, or false if it has any items

first

public byte first()

Returns the first (head) item in the deque (without removing it).

Specified by:

first in interface PrimitiveCollection.OfByte

Overrides:

first in class ByteList

Returns:

the first item, without modifying this

Throws:

NoSuchElementException - when the deque is empty

See Also:

• peeking won't throw an exception, and will return the ByteDeque's default value if empty
• removeFirst()

last

public byte last()

Returns the last (tail) item in the deque (without removing it).

Throws:

NoSuchElementException - when the deque is empty

See Also:

• peeking won't throw an exception, and will return the ByteDeque's default value if empty

get

public byte get(int index)

Returns the element at the specified position in this deque. Like ArrayList or ByteList, but unlike LinkedList, this runs in O(1) time. It is expected to be slightly slower than ByteList.get(int), which also runs in O(1) time. Unlike get() in ArrayList or ByteList, this considers negative indices to refer to the first item, and too-large indices to refer to the last item. That means it delegates to getFirst() or getLast() in those cases instead of throwing an IndexOutOfBoundsException, though it may throw a NoSuchElementException if the deque is empty and there is no item it can get.

Overrides:

get in class ByteList

Parameters:

index - index of the element to return

Returns:

the element at the specified position in this deque

Throws:

NoSuchElementException - if the deque is empty

peekAt

public byte peekAt(int index)

Returns the element at the specified position in this deque. Like ArrayList or ByteList, but unlike LinkedList, this runs in O(1) time. It is expected to be slightly slower than ByteList.get(int), which also runs in O(1) time. Unlike get() in ArrayList or ByteList, this considers negative indices to refer to the first item, and too-large indices to refer to the last item. That means it delegates to peekFirst() or peekLast() in those cases instead of throwing an IndexOutOfBoundsException, and it will return the default value if the deque is empty. Unless changed, the default value is usually null.

Parameters:

index - index of the element to return

Returns:

the element at the specified position in this deque

assign

public byte assign(int index,
 byte item)

Replaces the element at the specified position in this list with the specified element. If this deque is empty or the index is larger than the largest index currently in this deque, this delegates to addLast(byte) and returns the default value. If the index is negative, this delegates to addFirst(byte) and returns the default value.

Parameters:

index - index of the element to replace

item - element to be stored at the specified position

Returns:

the element previously at the specified position

set

public void set(int index,
 byte item)

Replaces the element at the specified position in this list with the specified element. If this deque is empty or the index is larger than the largest index currently in this deque, this delegates to addLast(byte) and returns the default value. If the index is negative, this delegates to addFirst(byte) and returns the default value.

Overrides:

set in class ByteList

Parameters:

index - index of the element to replace

item - element to be stored at the specified position

plus

public void plus(int index,
 byte value)

Overrides:

plus in class ByteList

plus

public ByteList plus(byte value)

Description copied from class: ByteList

Adds value to each item in this ByteList, stores it in this and returns it. The presence of this method allows Kotlin code to use the + operator (though it shouldn't be used more than once in an expression, because this method modifies this ByteList).

Overrides:

plus in class ByteList

Parameters:

value - each item in this will be assigned item + value

Returns:

this for chaining and Kotlin compatibility

times

public void times(int index,
 byte value)

Overrides:

times in class ByteList

times

public ByteList times(byte value)

Description copied from class: ByteList

Multiplies each item in this ByteList by value, stores it in this and returns it. The presence of this method allows Kotlin code to use the * operator (though it shouldn't be used more than once in an expression, because this method modifies this ByteList).

Overrides:

times in class ByteList

Parameters:

value - each item in this will be assigned item * value

Returns:

this for chaining and Kotlin compatibility

minus

public void minus(int index,
 byte value)

Overrides:

minus in class ByteList

minus

public ByteList minus(byte value)

Description copied from class: ByteList

Takes each item in this ByteList and subtracts value, stores it in this and returns it. This is just a minor convenience in Java, but the presence of this method allows Kotlin code to use the - operator (though it shouldn't be used more than once in an expression, because this method modifies this ByteList).

Overrides:

minus in class ByteList

Parameters:

value - each item in this will be assigned item - value

Returns:

this for chaining and Kotlin compatibility

div

public void div(int index,
 byte value)

Overrides:

div in class ByteList

div

public ByteList div(byte value)

Description copied from class: ByteList

Divides each item in this ByteList by value, stores it in this and returns it. The presence of this method allows Kotlin code to use the / operator (though it shouldn't be used more than once in an expression, because this method modifies this ByteList).

Overrides:

div in class ByteList

Parameters:

value - each item in this will be assigned item / value

Returns:

this for chaining and Kotlin compatibility

rem

public void rem(int index,
 byte value)

Overrides:

rem in class ByteList

rem

public ByteList rem(byte value)

Description copied from class: ByteList

Gets the remainder of each item in this ByteList with value, stores it in this and returns it. The presence of this method allows Kotlin code to use the % operator (though it shouldn't be used more than once in an expression, because this method modifies this ByteList).

Overrides:

rem in class ByteList

Parameters:

value - each item in this will be assigned item % value

Returns:

this for chaining and Kotlin compatibility

replaceAll

public void replaceAll(com.github.tommyettinger.function.ByteToByteFunction operator)

Description copied from class: ByteList

Replaces each element of this list with the result of applying the given operator to that element.

Overrides:

replaceAll in class ByteList

Parameters:

operator - a ByteToByteFunction (a functional interface defined in funderby)

replaceFirst

public boolean replaceFirst(byte find,
 byte replace)

Replaces the first occurrence of find with replace. Returns true if it performed the replacement, or false if there was nothing to replace. This also returns false if find and replace are the same.

Overrides:

replaceFirst in class ByteList

Parameters:

find - the item to search for

replace - the item to replace find with, if possible

Returns:

true if this changed, or false otherwise

replaceAll

public int replaceAll(byte find,
 byte replace)

Replaces every occurrence of find with replace. Returns the number of changed items, which is 0 if nothing was found or in the case that find and replace are the same.

Overrides:

replaceAll in class ByteList

Parameters:

find - the item to search for

replace - the item to replace find with, if possible

Returns:

the number of replacements that occurred; 0 if nothing was found or replaced

duplicateRange

public boolean duplicateRange(int index,
 int count)

Inserts the specified number of items at the specified index. The new items will have values equal to the values at those indices before the insertion, and the previous values will be pushed to after the duplicated range.

Overrides:

duplicateRange in class ByteList

Parameters:

index - the first index to duplicate

count - how many items to duplicate

clear

public void clear()

Removes all values from this deque. This operates in O(1) time.

Specified by:

clear in interface PrimitiveCollection<Byte>

Overrides:

clear in class ByteList

iterator

public ByteList.ByteListIterator iterator()

Returns an iterator for the items in the deque. Remove is supported.
Reuses one of two iterators for this deque. For nested or multithreaded iteration, use ByteDequeIterator(ByteDeque).

Specified by:

iterator in interface PrimitiveCollection<Byte>

Specified by:

iterator in interface PrimitiveCollection.OfByte

Overrides:

iterator in class ByteList

Returns:

a ByteIterator; use its nextByte() method instead of next()

descendingIterator

public ByteList.ByteListIterator descendingIterator()

Returns an iterator over the elements in this deque in reverse sequential order. The elements will be returned in order from last (tail) to first (head).
Reuses one of two descending iterators for this deque. For nested or multithreaded iteration, use ByteDequeIterator(ByteDeque, boolean).

Returns:

an iterator over the elements in this deque in reverse sequence

descendingIterator

public ByteList.ByteListIterator descendingIterator(int index)

Returns an iterator over the elements in this deque in reverse sequential order. The elements will be returned in order from index backwards to first (head).
Reuses one of two descending iterators for this deque. For nested or multithreaded iteration, use ByteDequeIterator(ByteDeque, boolean).

Parameters:

index - the index to start iterating from in this deque

Returns:

an iterator over the elements in this deque in reverse sequence

toString

public String toString()

Delegates to PrimitiveCollection.OfByte.toString(String, boolean) with a delimiter of ", " and square brackets enabled.

Overrides:

toString in class ByteList

Returns:

the square-bracketed String representation of this ByteDeque, with items separated by ", "

hashCode

public int hashCode()

Specified by:

hashCode in interface PrimitiveCollection<Byte>

Overrides:

hashCode in class ByteList

equals

public boolean equals(Object o)

Using == between each item in order, compares for equality with other subtypes of ByteList. If o is not a ByteList (and is also not somehow reference-equivalent to this collection), this returns false. This uses the PrimitiveCollection.OfByte.iterator() of both this and o, so if either is in the middle of a concurrent iteration that modifies the collection, this may fail.

Specified by:

equals in interface PrimitiveCollection<Byte>

Overrides:

equals in class ByteList

Parameters:

o - object to be compared for equality with this collection

Returns:

true if this is equal to o, or false otherwise

swap

public void swap(int first,
 int second)

Switches the ordering of positions first and second, without changing any items beyond that.

Specified by:

swap in interface Arrangeable

Specified by:

swap in interface Ordered.OfByte

Overrides:

swap in class ByteList

Parameters:

first - the first position, must not be negative and must be less than size()

second - the second position, must not be negative and must be less than size()

reverse

public void reverse()

Reverses this ByteDeque in-place.

Specified by:

reverse in interface Arrangeable

Specified by:

reverse in interface Ordered.OfByte

Overrides:

reverse in class ByteList

shuffle

public void shuffle(Random rng)

Description copied from interface: Ordered.OfByte

Pseudo-randomly shuffles the order of this Ordered in-place. You can seed rng, the random number generator, with an identical seed to reproduce a shuffle on two Ordered with the same Arrangeable.size().

Specified by:

shuffle in interface Arrangeable

Specified by:

shuffle in interface Ordered.OfByte

Overrides:

shuffle in class ByteList

Parameters:

rng - any Random class, such as one from juniper

sort

public void sort()

Sorts this deque in-place using Arrays.sort(byte[], int, int) in ascending order.

Overrides:

sort in class ByteList

sort

public void sort(int from,
 int to)

Uses Arrays.sort(byte[], int, int) to sort a (clamped) subrange of this deque.

Overrides:

sort in class ByteList

Parameters:

from - first index to use, inclusive

to - last index to use, exclusive

sort

public void sort(ByteComparator comparator)

Sorts this deque in-place using ByteComparators.sort(byte[], int, int, ByteComparator). This should operate in O(n log(n)) time or less when the internals of the deque are continuous (the head is before the tail in the array). If the internals are not continuous, this takes an additional O(n) step (where n is less than the size of the deque) to rearrange the internals before sorting. You can pass null as the value for comparator, which will make this use the natural ordering for byte.

Specified by:

sort in interface Ordered.OfByte

Overrides:

sort in class ByteList

Parameters:

comparator - the Comparator to use for byte items; may be null to use the natural order of byte items when byte implements Comparable of byte

sort

public void sort(int from,
 int to,
 ByteComparator comparator)

Description copied from class: ByteList

Sorts the specified range of elements according to the order induced by the specified comparator using mergesort, or Arrays.sort(byte[], int, int) if c is null. This purely uses ByteComparators.sort(byte[], int, int, ByteComparator), and you can see its docs for more information. This clamps from and to to the valid range.

Overrides:

sort in class ByteList

Parameters:

from - the index of the first element (inclusive) to be sorted

to - the index of the last element (exclusive) to be sorted

comparator - the comparator to determine the order of the ByteList

getRandom

public byte getRandom(Random random)

Gets a randomly selected item from this ByteDeque, using the given random number generator. Throws a NoSuchElementException if empty.

Parameters:

random - any Random or subclass of it, such as AlternateRandom.

Returns:

a randomly selected item from this deque

random

public byte random(Random random)

Gets a randomly selected item from this ByteDeque, using the given random number generator.

Specified by:

random in interface Ordered.OfByte

Overrides:

random in class ByteList

Parameters:

random - any Random or subclass of it, such as AlternateRandom.

Returns:

a randomly selected item from this deque, or the default value if empty

with

public static ByteDeque with()

Constructs an empty deque. This is usually less useful than just using the constructor, but can be handy in some code-generation scenarios when you don't know how many arguments you will have.

Returns:

a new deque containing nothing

with

public static ByteDeque with(byte item)

Creates a new ByteDeque that holds only the given item, but can be resized.

Parameters:

item - one byte item

Returns:

a new ByteDeque that holds the given item

with

public static ByteDeque with(byte item0,
 byte item1)

Creates a new ByteDeque that holds only the given items, but can be resized.

Parameters:

item0 - a byte item

item1 - a byte item

Returns:

a new ByteDeque that holds the given items

with

public static ByteDeque with(byte item0,
 byte item1,
 byte item2)

Creates a new ByteDeque that holds only the given items, but can be resized.

Parameters:

item0 - a byte item

item1 - a byte item

item2 - a byte item

Returns:

a new ByteDeque that holds the given items

with

public static ByteDeque with(byte item0,
 byte item1,
 byte item2,
 byte item3)

Creates a new ByteDeque that holds only the given items, but can be resized.

Parameters:

item0 - a byte item

item1 - a byte item

item2 - a byte item

item3 - a byte item

Returns:

a new ByteDeque that holds the given items

with

public static ByteDeque with(byte item0,
 byte item1,
 byte item2,
 byte item3,
 byte item4)

Creates a new ByteDeque that holds only the given items, but can be resized.

Parameters:

item0 - a byte item

item1 - a byte item

item2 - a byte item

item3 - a byte item

item4 - a byte item

Returns:

a new ByteDeque that holds the given items

with

public static ByteDeque with(byte item0,
 byte item1,
 byte item2,
 byte item3,
 byte item4,
 byte item5)

Creates a new ByteDeque that holds only the given items, but can be resized.

Parameters:

item0 - a byte item

item1 - a byte item

item2 - a byte item

item3 - a byte item

item4 - a byte item

item5 - a byte item

Returns:

a new ByteDeque that holds the given items

with

public static ByteDeque with(byte item0,
 byte item1,
 byte item2,
 byte item3,
 byte item4,
 byte item5,
 byte item6)

Creates a new ByteDeque that holds only the given items, but can be resized.

Parameters:

item0 - a byte item

item1 - a byte item

item2 - a byte item

item3 - a byte item

item4 - a byte item

item5 - a byte item

item6 - a byte item

Returns:

a new ByteDeque that holds the given items

with

public static ByteDeque with(byte item0,
 byte item1,
 byte item2,
 byte item3,
 byte item4,
 byte item5,
 byte item6,
 byte item7)

Creates a new ByteDeque that holds only the given items, but can be resized.

Parameters:

item0 - a byte item

item1 - a byte item

item2 - a byte item

item3 - a byte item

item4 - a byte item

item5 - a byte item

item6 - a byte item

item7 - a byte item

Returns:

a new ByteDeque that holds the given items

with

public static ByteDeque with(byte... varargs)

Creates a new ByteDeque that will hold the items in the given array or varargs. This overload will only be used when a byte array is supplied, or if varargs are used and there are 9 or more arguments.

Parameters:

varargs - either 0 or more byte items, or an array of byte

Returns:

a new ByteDeque that holds the given byte items

parse

public static ByteDeque parse(String str,
 String delimiter)

Calls parse(String, String, boolean) with brackets set to false.

Parameters:

str - a String that will be parsed in full

delimiter - the delimiter between items in str

Returns:

a new collection parsed from str

parse

public static ByteDeque parse(String str,
 String delimiter,
 boolean brackets)

Creates a new collection and fills it by calling PrimitiveCollection.OfByte.addLegible(String, String, int, int) on either all of str (if brackets is false) or str without its first and last chars (if brackets is true). Each item is expected to be separated by delimiter.

Parameters:

str - a String that will be parsed in full (depending on brackets)

delimiter - the delimiter between items in str

brackets - if true, the first and last chars in str will be ignored

Returns:

a new collection parsed from str

parse

public static ByteDeque parse(String str,
 String delimiter,
 int offset,
 int length)

Creates a new collection and fills it by calling PrimitiveCollection.OfByte.addLegible(String, String, int, int) with the given four parameters as-is.

Parameters:

str - a String that will have the given section parsed

delimiter - the delimiter between items in str

offset - the first position to parse in str, inclusive

length - how many chars to parse, starting from offset

Returns:

a new collection parsed from str