Package org.apache.flink.runtime.state.heap

Class HeapKeyValueStateIterator

java.lang.Object

org.apache.flink.runtime.state.heap.HeapKeyValueStateIterator

All Implemented Interfaces:

AutoCloseable, KeyValueStateIterator

@Internal
@NotThreadSafe
public final class HeapKeyValueStateIterator
extends Object
implements KeyValueStateIterator

A KeyValueStateIterator over Heap backend snapshot resources.

Constructor Summary

Constructors

Constructor	Description
HeapKeyValueStateIterator(KeyGroupRange keyGroupRange, org.apache.flink.api.common.typeutils.TypeSerializer<?> keySerializer, int totalKeyGroups, Map<org.apache.flink.runtime.state.heap.StateUID,Integer> stateNamesToId, Map<org.apache.flink.runtime.state.heap.StateUID,StateSnapshot> stateSnapshots)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	isNewKeyGroup()	Indicates if current key starts a new key-group, i.e. belong to a different key-group than it's predecessor.
boolean	isNewKeyValueState()	Indicates if current key starts a new k/v-state, i.e. belong to a different k/v-state than it's predecessor.
boolean	isValid()	Check if the iterator is still valid.
byte[]	key()
int	keyGroup()	Returns the key-group for the current key.
int	kvStateId()	Returns the Id of the K/V state to which the current key belongs.
void	next()	Advances the iterator.
byte[]	value()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeapKeyValueStateIterator

public HeapKeyValueStateIterator(@Nonnull
                                 KeyGroupRange keyGroupRange,
                                 @Nonnull
                                 org.apache.flink.api.common.typeutils.TypeSerializer<?> keySerializer,
                                 @Nonnegative
                                 int totalKeyGroups,
                                 @Nonnull
                                 Map<org.apache.flink.runtime.state.heap.StateUID,Integer> stateNamesToId,
                                 @Nonnull
                                 Map<org.apache.flink.runtime.state.heap.StateUID,StateSnapshot> stateSnapshots)
                          throws IOException

Throws:

IOException

Method Detail

isValid

public boolean isValid()

Description copied from interface: KeyValueStateIterator

Check if the iterator is still valid. Getters like KeyValueStateIterator.key(), KeyValueStateIterator.value(), etc. as well as KeyValueStateIterator.next() should only be called if valid returned true. Should be checked after each call to KeyValueStateIterator.next() before accessing iterator state.

Specified by:

isValid in interface KeyValueStateIterator

Returns:

True iff this iterator is valid.

isNewKeyValueState

public boolean isNewKeyValueState()

Description copied from interface: KeyValueStateIterator

Indicates if current key starts a new k/v-state, i.e. belong to a different k/v-state than it's predecessor.

Specified by:

isNewKeyValueState in interface KeyValueStateIterator

Returns:

true iff the current key belong to a different k/v-state than it's predecessor.

isNewKeyGroup

public boolean isNewKeyGroup()

Description copied from interface: KeyValueStateIterator

Indicates if current key starts a new key-group, i.e. belong to a different key-group than it's predecessor.

Specified by:

isNewKeyGroup in interface KeyValueStateIterator

Returns:

true iff the current key belong to a different key-group than it's predecessor.

keyGroup

public int keyGroup()

Description copied from interface: KeyValueStateIterator

Returns the key-group for the current key.

Specified by:

keyGroup in interface KeyValueStateIterator

kvStateId

public int kvStateId()

Description copied from interface: KeyValueStateIterator

Returns the Id of the K/V state to which the current key belongs.

Specified by:

kvStateId in interface KeyValueStateIterator

next

public void next()
          throws IOException

Description copied from interface: KeyValueStateIterator

Advances the iterator. Should only be called if KeyValueStateIterator.isValid() returned true. Valid flag can only change after calling KeyValueStateIterator.next().

Specified by:

next in interface KeyValueStateIterator

Throws:

IOException

key

public byte[] key()

Specified by:

key in interface KeyValueStateIterator

value

public byte[] value()

Specified by:

value in interface KeyValueStateIterator

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface KeyValueStateIterator