org.apache.flink.runtime.state.heap

类 HeapKeyValueStateIterator

java.lang.Object

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

所有已实现的接口:

AutoCloseable, KeyValueStateIterator

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

A KeyValueStateIterator over Heap backend snapshot resources.

构造器概要

构造器

构造器和说明
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)

方法概要

限定符和类型	方法和说明
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()

从类继承的方法 java.lang.Object

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

构造器详细资料

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

抛出:

IOException

方法详细资料

isValid

public boolean isValid()

从接口复制的说明: 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.

指定者:

isValid 在接口中 KeyValueStateIterator

返回:

True iff this iterator is valid.

isNewKeyValueState

public boolean isNewKeyValueState()

从接口复制的说明: KeyValueStateIterator

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

指定者:

isNewKeyValueState 在接口中 KeyValueStateIterator

返回:

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

isNewKeyGroup

public boolean isNewKeyGroup()

从接口复制的说明: KeyValueStateIterator

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

指定者:

isNewKeyGroup 在接口中 KeyValueStateIterator

返回:

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

keyGroup

public int keyGroup()

从接口复制的说明: KeyValueStateIterator

Returns the key-group for the current key.

指定者:

keyGroup 在接口中 KeyValueStateIterator

kvStateId

public int kvStateId()

从接口复制的说明: KeyValueStateIterator

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

指定者:

kvStateId 在接口中 KeyValueStateIterator

next

public void next()
          throws IOException

从接口复制的说明: KeyValueStateIterator

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

指定者:

next 在接口中 KeyValueStateIterator

抛出:

IOException

key

public byte[] key()

指定者:

key 在接口中 KeyValueStateIterator

value

public byte[] value()

指定者:

value 在接口中 KeyValueStateIterator

close

public void close()

指定者:

close 在接口中 AutoCloseable

指定者:

close 在接口中 KeyValueStateIterator