org.apache.flink.graph.types.valuearray

Interface ValueArray<T>

Type Parameters:

T - the Value type

All Superinterfaces:

Comparable<ValueArray<T>>, org.apache.flink.types.CopyableValue<ValueArray<T>>, org.apache.flink.core.io.IOReadableWritable, Iterable<T>, org.apache.flink.types.Key<ValueArray<T>>, org.apache.flink.types.NormalizableKey<ValueArray<T>>, org.apache.flink.types.ResettableValue<ValueArray<T>>, Serializable, org.apache.flink.types.Value

All Known Implementing Classes:

ByteValueArray, CharValueArray, DoubleValueArray, FloatValueArray, IntValueArray, LongValueArray, NullValueArray, ShortValueArray, StringValueArray

@TypeInfo(value=ValueArrayTypeInfoFactory.class)
public interface ValueArray<T>
extends Iterable<T>, org.apache.flink.core.io.IOReadableWritable, Serializable, org.apache.flink.types.NormalizableKey<ValueArray<T>>, org.apache.flink.types.ResettableValue<ValueArray<T>>, org.apache.flink.types.CopyableValue<ValueArray<T>>

Basic interface for array types which reuse objects during serialization.

Value arrays are usable as grouping keys but not sorting keys.

Method Summary

Modifier and Type	Method and Description
boolean	add(T value) Appends the value to this array if and only if the array capacity would not be exceeded.
boolean	addAll(ValueArray<T> source) Appends all of the values in the specified array to the end of this array.
void	clear() Resets the array to the empty state.
boolean	isFull() An bounded array fills when the allocated capacity has been fully used.
void	mark() Saves the array index, which can be restored by calling reset().
void	reset() Restores the array index to when mark() was last called.
int	size() Returns the number of elements stored in the array.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.apache.flink.types.NormalizableKey

copyNormalizedKey, getMaxNormalizedKeyLen

Methods inherited from interface org.apache.flink.types.Key

equals, hashCode

Methods inherited from interface org.apache.flink.core.io.IOReadableWritable

read, write

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface org.apache.flink.types.ResettableValue

setValue

Methods inherited from interface org.apache.flink.types.CopyableValue

copy, copy, copyTo, getBinaryLength

Method Detail

size

int size()

Returns the number of elements stored in the array.

Returns:

the number of elements stored in the array

isFull

boolean isFull()

An bounded array fills when the allocated capacity has been fully used. An unbounded array will only fill when the underlying data structure has reached capacity, for example the ~2^31 element limit for Java arrays.

Returns:

whether the array is full

add

boolean add(T value)

Appends the value to this array if and only if the array capacity would not be exceeded.

Parameters:

value - the value to add to this array

Returns:

whether the value was added to the array

addAll

boolean addAll(ValueArray<T> source)

Appends all of the values in the specified array to the end of this array. If the combined array would exceed capacity then no values are appended.

Parameters:

source - array containing values to be added to this array

Returns:

whether the values were added to the array

mark

void mark()

Saves the array index, which can be restored by calling reset().

This is not serialized and is not part of the contract for Key.equals(Object).

reset

void reset()

Restores the array index to when mark() was last called.

clear

void clear()

Resets the array to the empty state. The implementation is *not* expected to release the underlying data structure. This allows the array to be reused with minimal impact on the garbage collector.

This may reset the mark() in order to allow arrays be shrunk.