libGDX 1.14.2 · com.badlogic.gdx.utils.ByteArray · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public byte[]	items
public boolean	ordered
public int	size

Access	Constructor and Description
public	ByteArray() Creates an ordered array with a capacity of 16.
public	ByteArray(int capacity) Creates an ordered array with the specified capacity.
public	ByteArray(boolean If false, methods that remove elements may change the order of other elements in the array, which avoids a memory copy. ordered, int Any elements added beyond this will cause the backing array to be grown. capacity)
public	ByteArray(ByteArray array) Creates a new array containing the elements in the specific array.
public	ByteArray(byte[] array) Creates a new ordered array containing the elements in the specified array.
public	ByteArray(boolean If false, methods that remove elements may change the order of other elements in the array, which avoids a memory copy. ordered, byte[] array, int startIndex, int count) Creates a new array containing the elements in the specified array.

Method Summary

Modifier and Type	Method and Description
public void	add(byte value)
public void	add(byte value1, byte value2)
public void	add(byte value1, byte value2, byte value3)
public void	add(byte value1, byte value2, byte value3, byte value4)
public void	addAll(ByteArray array)
public void	addAll(ByteArray array, int offset, int length)
public void	addAll(byte... array)
public void	addAll(byte[] array, int offset, int length)
public void	clear()
public boolean	contains(byte value)
public byte[]	Returns: `items` ensureCapacity(int additionalCapacity) Increases the size of the backing array to accommodate the specified number of additional items.
public boolean	equals(Object object) Overrides java.lang.Object.equals. Returns false if either array is unordered.
public byte	first() Returns the first item.
public byte	get(int index)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public void	incr(int index, byte value)
public void	incr(byte value)
public int	indexOf(byte value)
public void	insert(int index, byte value)
public void	insertRange(int index, int count) Inserts the specified number of items at the specified index.
public boolean	isEmpty() Returns true if the array is empty.
public int	lastIndexOf(byte value)
public void	mul(int index, byte value)
public void	mul(byte value)
public boolean	notEmpty() Returns true if the array has one or more items.
public byte	peek() Returns the last item.
public byte	pop() Removes and returns the last item.
public byte	random() Returns a random item from the array, or zero if the array is empty.
public boolean	Returns: true if this array was modified. removeAll(ByteArray array) Removes from this array the first instance of each element contained in the specified array.
public int	removeIndex(int index) Removes and returns the item at the specified index.
public void	removeRange(int start, int end) Removes the items between the specified indices, inclusive.
public boolean	removeValue(byte value)
public int	Returns: the number of replacements done replaceAll(byte the byte to be replaced value, byte all occurrences of value will be replaced by this replacement replacement) Returns the number of replacements done.
public boolean	Returns: if value was found and replaced replaceFirst(byte the byte to be replaced value, byte the first value will be replaced by this replacement if found replacement) Returns true if the specified value was replaced successfully with the replacement
protected byte[]	resize(int newSize)
public void	reverse()
public void	set(int index, byte value)
public byte[]	Returns: `items` setSize(int newSize) Sets the array size, leaving any values beyond the current size undefined.
public byte[]	Returns: `items` shrink() Reduces the size of the backing array to the size of the actual items.
public void	shuffle()
public void	sort()
public void	swap(int first, int second)
public byte[]	toArray()
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public String	toString(String separator)
public void	truncate(int newSize) Reduces the size of the array to the specified size.
public static ByteArray	with(byte... array)

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

items	back to summary
public byte[] items

ordered	back to summary
public boolean ordered

size	back to summary
public int size

Constructor Detail

ByteArray	back to summary
public ByteArray() Creates an ordered array with a capacity of 16.

ByteArray	back to summary
public ByteArray(int capacity) Creates an ordered array with the specified capacity.

ByteArray	back to summary
public ByteArray(boolean ordered, int capacity) Parameters ordered:boolean If false, methods that remove elements may change the order of other elements in the array, which avoids a memory copy. capacity:int Any elements added beyond this will cause the backing array to be grown.

ByteArray	back to summary
public ByteArray(ByteArray array) Creates a new array containing the elements in the specific array. The new array will be ordered if the specific array is ordered. The capacity is set to the number of elements, so any subsequent elements added will cause the backing array to be grown.

ByteArray	back to summary
public ByteArray(byte[] array) Creates a new ordered array 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.

ByteArray	back to summary
public ByteArray(boolean ordered, byte[] array, int startIndex, int count) Creates a new array 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 ordered:boolean If false, methods that remove elements may change the order of other elements in the array, which avoids a memory copy.

ByteArray

back to summary

public ByteArray(boolean ordered, byte[] array, int startIndex, int count)

Creates a new array 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

ordered:boolean: If false, methods that remove elements may change the order of other elements in the array, which avoids a memory copy.

Method Detail

add	back to summary
public void add(byte value)

add	back to summary
public void add(byte value1, byte value2)

add	back to summary
public void add(byte value1, byte value2, byte value3)

add	back to summary
public void add(byte value1, byte value2, byte value3, byte value4)

addAll	back to summary
public void addAll(ByteArray array)

addAll	back to summary
public void addAll(ByteArray array, int offset, int length)

addAll	back to summary
public void addAll(byte... array)

addAll	back to summary
public void addAll(byte[] array, int offset, int length)

clear	back to summary
public void clear()

contains	back to summary
public boolean contains(byte value)

ensureCapacity back to summary

ensureCapacity	back to summary
public byte[] ensureCapacity(int additionalCapacity) 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. Returns:byte[] `items`

public byte[] ensureCapacity(int additionalCapacity)

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.

Returns:byte[]: items

equals	back to summary
public boolean equals(Object object) Overrides java.lang.Object.equals. Returns false if either array is unordered.

equals

back to summary

public boolean equals(Object object)

Overrides java.lang.Object.equals.

Returns false if either array is unordered.

first	back to summary
public byte first() Returns the first item.

get	back to summary
public byte get(int index)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

incr	back to summary
public void incr(int index, byte value)

incr	back to summary
public void incr(byte value)

indexOf	back to summary
public int indexOf(byte value)

insert	back to summary
public void insert(int index, byte value)

insertRange	back to summary
public void insertRange(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.

isEmpty	back to summary
public boolean isEmpty() Returns true if the array is empty.

lastIndexOf	back to summary
public int lastIndexOf(byte value)

mul	back to summary
public void mul(int index, byte value)

mul	back to summary
public void mul(byte value)

notEmpty	back to summary
public boolean notEmpty() Returns true if the array has one or more items.

peek	back to summary
public byte peek() Returns the last item.

pop	back to summary
public byte pop() Removes and returns the last item.

random	back to summary
public byte random() Returns a random item from the array, or zero if the array is empty.

removeAll	back to summary
public boolean removeAll(ByteArray array) Removes from this array the first instance of each element contained in the specified array. Returns:boolean true if this array was modified.

removeAll

back to summary

public boolean removeAll(ByteArray array)

Removes from this array the first instance of each element contained in the specified array.

Returns:boolean: true if this array was modified.

removeIndex	back to summary
public int removeIndex(int index) Removes and returns the item at the specified index.

removeRange	back to summary
public void removeRange(int start, int end) Removes the items between the specified indices, inclusive.

removeValue	back to summary
public boolean removeValue(byte value)

replaceAll	back to summary
public int replaceAll(byte value, byte replacement) Returns the number of replacements done. Parameters value:byte the byte to be replaced replacement:byte all occurrences of value will be replaced by this replacement Returns:int the number of replacements done

replaceAll

back to summary

public int replaceAll(byte value, byte replacement)

Returns the number of replacements done.

Parameters

value:byte: the byte to be replaced
replacement:byte: all occurrences of value will be replaced by this replacement

Returns:int

the number of replacements done

replaceFirst	back to summary
public boolean replaceFirst(byte value, byte replacement) Returns true if the specified value was replaced successfully with the replacement Parameters value:byte the byte to be replaced replacement:byte the first value will be replaced by this replacement if found Returns:boolean if value was found and replaced

replaceFirst

back to summary

public boolean replaceFirst(byte value, byte replacement)

Returns true if the specified value was replaced successfully with the replacement

Parameters

value:byte: the byte to be replaced
replacement:byte: the first value will be replaced by this replacement if found

Returns:boolean

if value was found and replaced

resize	back to summary
protected byte[] resize(int newSize)

reverse	back to summary
public void reverse()

set	back to summary
public void set(int index, byte value)

setSize back to summary

setSize	back to summary
public byte[] setSize(int newSize) Sets the array size, leaving any values beyond the current size undefined. Returns:byte[] `items`

public byte[] setSize(int newSize)

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

Returns:byte[]: items

shrink back to summary

public byte[] shrink()

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.

Returns:byte[]: items

shuffle	back to summary
public void shuffle()

sort	back to summary
public void sort()

swap	back to summary
public void swap(int first, int second)

toArray	back to summary
public byte[] toArray()

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

toString	back to summary
public String toString(String separator)

truncate	back to summary
public void truncate(int newSize) Reduces the size of the array to the specified size. If the array is already smaller than the specified size, no action is taken.

with	back to summary
public static ByteArray with(byte... array) See Also `ByteArray(byte[])`

public Class ByteArray

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail