Package com.github.tommyettinger.ds

Class ByteBag

java.lang.Object

com.github.tommyettinger.ds.ByteList

com.github.tommyettinger.ds.ByteBag

All Implemented Interfaces:

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

public class ByteBag
extends ByteList

An unordered List of byte items. This allows efficient iteration via a reused iterator or via index. This class avoids a memory copy when removing elements (the last element is moved to the removed element's position). Items are permitted to change position in the ordering when any item is removed or added. Although this won't keep an order during modifications, you can ByteList.sort() the bag to ensure, if no modifications are made later, that the iteration will happen in sorted order.

Nested Class Summary

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 inherited from class com.github.tommyettinger.ds.ByteList

items, iterator1, iterator2, size

Constructor Summary

Constructors

Constructor	Description
ByteBag()	Creates an ordered bag with a capacity of 10.
ByteBag(byte[] array)	Creates a new bag containing the elements in the specified array.
ByteBag(byte[] array, int startIndex, int count)	Creates a new bag containing the elements in the specified array.
ByteBag(int capacity)	Creates an ordered bag with the specified capacity.
ByteBag(ByteList list)	Creates a new bag containing the elements in the specific list or bag.
ByteBag(Ordered.OfByte other)	Copies the given Ordered.OfByte into a new bag.
ByteBag(Ordered.OfByte other, int offset, int count)	Creates a new bag by copying count items from the given Ordered, starting at offset in that Ordered, into this.
ByteBag(PrimitiveCollection.OfByte coll)	Creates a new bag containing the items in the specified PrimitiveCollection.OfByte.
ByteBag(ByteIterator coll)	Creates a new instance containing the items in the specified iterator.

Method Summary

Modifier and Type	Method	Description
int	hashCode()
void	insert(int index, byte element)	This always adds element to the end of this bag's ordering.
boolean	keepsOrder()	Returns true if this implementation retains order, which it does not.
static ByteBag	parse(String str, String delimiter)	Calls parse(String, String, boolean) with brackets set to false.
static ByteBag	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 ByteBag	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	removeAt(int index)	Removes and returns the item at the specified index.
void	removeRange(int start, int end)	Removes the items between the specified start index, inclusive, and end index, exclusive.
static ByteBag	with()	Constructs an empty bag.
static ByteBag	with(byte item)	Creates a new ByteBag that holds only the given item, but can be resized.
static ByteBag	with(byte... varargs)	Creates a new ByteBag that holds only the given items, but can be resized.
static ByteBag	with(byte item0, byte item1)	Creates a new ByteBag that holds only the given items, but can be resized.
static ByteBag	with(byte item0, byte item1, byte item2)	Creates a new ByteBag that holds only the given items, but can be resized.
static ByteBag	with(byte item0, byte item1, byte item2, byte item3)	Creates a new ByteBag that holds only the given items, but can be resized.
static ByteBag	with(byte item0, byte item1, byte item2, byte item3, byte item4)	Creates a new ByteBag that holds only the given items, but can be resized.
static ByteBag	with(byte item0, byte item1, byte item2, byte item3, byte item4, byte item5)	Creates a new ByteBag that holds only the given items, but can be resized.
static ByteBag	with(byte item0, byte item1, byte item2, byte item3, byte item4, byte item5, byte item6)	Creates a new ByteBag that holds only the given items, but can be resized.
static ByteBag	with(byte item0, byte item1, byte item2, byte item3, byte item4, byte item5, byte item6, byte item7)	Creates a new ByteBag that holds only the given items, but can be resized.

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

add, add, add, add, addAll, addAll, addAll, addAll, addAll, addAll, clear, contains, containsAll, div, div, duplicateRange, ensureCapacity, equals, first, get, indexOf, isEmpty, iterator, lastIndexOf, minus, minus, notEmpty, order, peek, plus, plus, pop, random, rem, rem, remove, removeAll, removeEach, replaceAll, replaceAll, replaceFirst, resize, retainAll, reverse, set, setSize, shrink, shuffle, size, sort, sort, sort, sort, swap, times, times, toArray, toArray, toString, trimToSize, truncate

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

Constructor Details

ByteBag

public ByteBag()

Creates an ordered bag with a capacity of 10.

ByteBag

public ByteBag(int capacity)

Creates an ordered bag with the specified capacity.

Parameters:

capacity -

ByteBag

public ByteBag(ByteList list)

Creates a new bag containing the elements in the specific list or bag. The capacity is set to the number of elements, so any subsequent elements added will cause the backing array to be grown.

Parameters:

list - another ByteList or ByteBag

ByteBag

public ByteBag(byte[] array)

Creates a new bag containing the elements in the specified array. The capacity is set to the number of elements, so any subsequent elements added will cause the backing array to be grown.

Parameters:

array - a non-null byte array to add to this bag

ByteBag

public ByteBag(byte[] array,
 int startIndex,
 int count)

Creates a new bag containing the elements in the specified array. The capacity is set to the number of elements, so any subsequent elements added will cause the backing array to be grown.

Parameters:

array - a non-null byte array to add to this bag

startIndex - the first index in array to use

count - how many items to use from array

ByteBag

public ByteBag(PrimitiveCollection.OfByte coll)

Creates a new bag containing the items in the specified PrimitiveCollection.OfByte.

Parameters:

coll - a primitive collection that will have its contents added to this

ByteBag

public ByteBag(ByteIterator coll)

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

Parameters:

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

ByteBag

public ByteBag(Ordered.OfByte other)

Copies the given Ordered.OfByte into a new bag.

Parameters:

other - another Ordered.OfByte

ByteBag

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

Creates a new bag by copying count items from the given Ordered, starting at offset in that Ordered, into this.

Parameters:

other - another Ordered.OfByte

offset - the first index in other's ordering to draw an item from

count - how many items to copy from other

Method Details

keepsOrder

public boolean keepsOrder()

Returns true if this implementation retains order, which it does not.

Overrides:

keepsOrder in class ByteList

Returns:

false

insert

public void insert(int index,
 byte element)

This always adds element to the end of this bag's ordering.

Overrides:

insert in class ByteList

Parameters:

index - ignored

element - element to be inserted

removeAt

public byte removeAt(int index)

Removes and returns the item at the specified index. Note that this is equivalent to List.remove(int), but can't have that name because we also have ByteList.remove(byte) that removes a value, rather than an index.

Overrides:

removeAt in class ByteList

Parameters:

index - the index of the item to remove and return

Returns:

the removed item

removeRange

public void removeRange(int start,
 int end)

Removes the items between the specified start index, inclusive, and end index, exclusive. Note that this takes different arguments than some other range-related methods; this needs a start index and an end index, rather than a count of items. This matches the behavior in the JDK collections.

Specified by:

removeRange in interface Ordered.OfByte

Overrides:

removeRange in class ByteList

Parameters:

start - the first index to remove, inclusive

end - the last index (after what should be removed), exclusive

hashCode

public int hashCode()

Specified by:

hashCode in interface PrimitiveCollection<Byte>

Overrides:

hashCode in class ByteList

with

public static ByteBag with()

Constructs an empty bag. 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 bag containing nothing

with

public static ByteBag with(byte item)

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

Parameters:

item - a byte item

Returns:

a new ByteBag that holds the given item

with

public static ByteBag with(byte item0,
 byte item1)

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

Parameters:

item0 - a byte item

item1 - a byte item

Returns:

a new ByteBag that holds the given items

with

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

Creates a new ByteBag 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 ByteBag that holds the given items

with

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

Creates a new ByteBag 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 ByteBag that holds the given items

with

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

Creates a new ByteBag 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 ByteBag that holds the given items

with

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

Creates a new ByteBag 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 ByteBag that holds the given items

with

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

Creates a new ByteBag 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 ByteBag that holds the given items

with

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

Creates a new ByteBag 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 ByteBag that holds the given items

with

public static ByteBag with(byte... varargs)

Creates a new ByteBag that holds only the given items, but can be resized. This overload will only be used when an array is supplied and the type of the items requested is the component type of the array, or if varargs are used and there are 9 or more arguments.

Parameters:

varargs - a byte varargs or byte array; remember that varargs allocate

Returns:

a new ByteBag that holds the given items

parse

public static ByteBag 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 ByteBag 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 ByteBag 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