us.hebi.quickbuf

Class RepeatedEnum<E extends ProtoEnum>

java.lang.Object

us.hebi.quickbuf.RepeatedEnum<E>

All Implemented Interfaces:

Iterable<E>

public final class RepeatedEnum<E extends ProtoEnum>
extends Object

Enum values are internally stored as an integers. This class contains helper methods to convert to and from the enum representations. The *Value methods access the internal storage directly and do not go through any validity checks.

Since:

17 Nov 2019

Author:

Florian Enner

Field Summary

Fields

Modifier and Type	Field and Description
protected int	length

Method Summary

Modifier and Type	Method and Description
RepeatedEnum<E>	add(E value)
RepeatedEnum<E>	addAll(E... values)
RepeatedEnum<E>	addAll(E[] buffer, int offset, int length)
void	addAll(RepeatedEnum<E> values)
RepeatedEnum<E>	addAllValues(int... values)
RepeatedEnum<E>	addAllValues(int[] buffer, int offset, int length)
int	addLength(int length) Sets the length to length + offset and returns the previous length.
RepeatedEnum<E>	addValue(int value)
int[]	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.
RepeatedEnum<E>	copyFrom(E[] buffer)
RepeatedEnum<E>	copyFrom(E[] buffer, int offset, int length)
void	copyFrom(RepeatedEnum<E> other)
RepeatedEnum<E>	copyFromValues(int[] buffer)
RepeatedEnum<E>	copyFromValues(int[] buffer, int offset, int length)
boolean	equals(Object o)
protected void	extendCapacityTo(int desiredSize)
E	get(int index)
int	getValue(int index)
protected E	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 <E extends ProtoEnum> RepeatedEnum<E>	newEmptyInstance(ProtoEnum.EnumConverter<E> converter)
int	remainingCapacity()
RepeatedType	reserve(int count) Makes sure that the internal storage capacity has space for at least the requested number of entries.
RepeatedEnum<E>	set(int index, E value)
RepeatedEnum<E>	setLength(int length) Sets the absolute length of the data that can be serialized.
RepeatedEnum<E>	setValue(int index, int value)
int[]	toArray() Creates a copy of the valid data contained in the internal storage.
String	toString()

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 <E extends ProtoEnum> RepeatedEnum<E> newEmptyInstance(ProtoEnum.EnumConverter<E> converter)

getValueAt

protected E getValueAt(int index)

get

public E get(int index)

set

public RepeatedEnum<E> set(int index,
                           E value)

add

public RepeatedEnum<E> add(E value)

addAll

public RepeatedEnum<E> addAll(E... values)

addAll

public RepeatedEnum<E> addAll(E[] buffer,
                              int offset,
                              int length)

copyFrom

public RepeatedEnum<E> copyFrom(E[] buffer)

copyFrom

public RepeatedEnum<E> copyFrom(E[] buffer,
                                int offset,
                                int length)

copyFrom

public void copyFrom(RepeatedEnum<E> other)

addAll

public void addAll(RepeatedEnum<E> values)

getValue

public int getValue(int index)

setValue

public RepeatedEnum<E> setValue(int index,
                                int value)

addValue

public RepeatedEnum<E> addValue(int value)

addAllValues

public RepeatedEnum<E> addAllValues(int... values)

addAllValues

public RepeatedEnum<E> addAllValues(int[] buffer,
                                    int offset,
                                    int length)

copyFromValues

public RepeatedEnum<E> copyFromValues(int[] buffer)

copyFromValues

public RepeatedEnum<E> copyFromValues(int[] buffer,
                                      int offset,
                                      int length)

capacity

public int capacity()

Returns:

total capacity of the internal storage array

toArray

public final int[] toArray()

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

Returns:

copy of valid data

array

public final int[] 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 RepeatedEnum<E> 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 accomodate at least the desired length.

See setLength(int)

Parameters:

length - added to the current length

Returns:

previous length

extendCapacityTo

protected void extendCapacityTo(int desiredSize)

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

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