us.hebi.quickbuf

Class RepeatedByte

java.lang.Object

us.hebi.quickbuf.RepeatedByte

All Implemented Interfaces:

Iterable<Byte>

public final class RepeatedByte
extends Object

Class that represents the data for a repeated byte field.

Since:

09 Aug 2019

Author:

Florian Enner

Field Summary

Fields

Modifier and Type	Field and Description
protected int	length

Method Summary

Modifier and Type	Method and Description
RepeatedByte	add(byte value)
RepeatedByte	addAll(byte[] values)
RepeatedByte	addAll(byte[] buffer, int offset, int length)
void	addAll(RepeatedByte values)
int	addLength(int length) Sets the length to length + offset and returns the previous length.
byte[]	array() Provides access to the internal storage array.
int	capacity()
protected void	checkIndex(int index)
RepeatedType	clear() Sets the output length to zero and performs any necessary cleanup of the content.
RepeatedByte	copyFrom(byte[] buffer)
RepeatedByte	copyFrom(byte[] buffer, int offset, int length)
void	copyFrom(RepeatedByte other)
boolean	equals(Object o)
protected void	extendCapacityTo(int desiredSize)
byte	get(int index)
protected Byte	getValueAt(int index)
int	hashCode() Repeated fields have no immutable state and should not be used in hashing structures.
us.hebi.quickbuf.RepeatedField.GenericIterator	iterator()
int	length()
static RepeatedByte	newEmptyInstance()
static RepeatedByte	newInstance(byte[] initialValue)
int	remainingCapacity()
RepeatedType	reserve(int count) Makes sure that the internal storage capacity has space for at least the requested number of entries.
RepeatedByte	set(int index, byte value)
RepeatedByte	setInternalArray(byte[] array) Gifts ownership of the supplied array and uses it as the internal storage array.
RepeatedByte	setInternalArray(byte[] array, int length)
RepeatedByte	setLength(int length) Sets the absolute length of the data that can be serialized.
byte[]	toArray() Creates a copy of the valid data contained in the internal storage.
String	toString()
RepeatedByte	writeTo(ByteBuffer buffer)
RepeatedByte	writeTo(OutputStream outputStream)
RepeatedByte	writeTo(ProtoSink sink)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

length

protected int length

Method Detail

newEmptyInstance

public static RepeatedByte newEmptyInstance()

newInstance

public static RepeatedByte newInstance(byte[] initialValue)

extendCapacityTo

protected void extendCapacityTo(int desiredSize)

getValueAt

protected Byte getValueAt(int index)

get

public byte get(int index)

set

public RepeatedByte set(int index,
                        byte value)

add

public RepeatedByte add(byte value)

addAll

public RepeatedByte addAll(byte[] values)

addAll

public RepeatedByte addAll(byte[] buffer,
                           int offset,
                           int length)

copyFrom

public RepeatedByte copyFrom(byte[] buffer)

copyFrom

public RepeatedByte copyFrom(byte[] buffer,
                             int offset,
                             int length)

addAll

public void addAll(RepeatedByte values)

copyFrom

public void copyFrom(RepeatedByte other)

setInternalArray

public RepeatedByte setInternalArray(byte[] array)

Gifts ownership of the supplied array and uses it as the internal storage array. Subsequent write actions may change the contents, and append actions may replace the internal storage array with something else.

Parameters:

array - array with valid data from zero to length

Returns:

this

setInternalArray

public RepeatedByte setInternalArray(byte[] array,
                                     int length)

capacity

public int capacity()

Returns:

total capacity of the internal storage array

toArray

public final byte[] toArray()

Creates a copy of the valid data contained in the internal storage.

Returns:

copy of only valid data

array

public final byte[] array()

Provides access to the internal storage array. Do not hold on to this reference as it can change during a resize.

The array may be larger than the amount of contained data, but the data is only valid between index 0 and length.

Returns:

internal storage array

setLength

public final RepeatedByte setLength(int length)

Sets the absolute length of the data that can be serialized. The internal storage array may get extended to accommodate at least the desired length.

This does not change the underlying data, so setting a length longer than the current one may result in arbitrary data being serialized.

Parameters:

length - desired length

Returns:

this

addLength

public final int addLength(int length)

Sets the length to length + offset and returns the previous length. The internal storage array may get extended to accommodate at least the desired length.

It is expected that users don't know the exact desired size, so the growth rate is the same as a generic ArrayList.

See setLength(int)

Parameters:

length - added to the current length

Returns:

previous length

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

writeTo

public RepeatedByte writeTo(ProtoSink sink)
                     throws IOException

Throws:

IOException

writeTo

public RepeatedByte writeTo(OutputStream outputStream)
                     throws IOException

Throws:

IOException

writeTo

public RepeatedByte writeTo(ByteBuffer buffer)

length

public final int length()

remainingCapacity

public final int remainingCapacity()

iterator

public us.hebi.quickbuf.RepeatedField.GenericIterator iterator()

Specified by:

iterator in interface Iterable<GenericType>

reserve

public final RepeatedType reserve(int count)

Makes sure that the internal storage capacity has space for at least the requested number of entries. This method will increase the internal capacity if needed.

Parameters:

count - number of entries to be added

clear

public RepeatedType clear()

Sets the output length to zero and performs any necessary cleanup of the content. Does not release the internal buffer.

checkIndex

protected final void checkIndex(int index)

hashCode

public final int hashCode()

Repeated fields have no immutable state and should not be used in hashing structures. This method returns a constant value.

Overrides:

hashCode in class Object

Returns:

0