org.apache.flink.runtime.state.heap

类 NestedStateMap<K,N,S>

java.lang.Object

org.apache.flink.runtime.state.heap.StateMap<K,N,S>

org.apache.flink.runtime.state.heap.NestedStateMap<K,N,S>

类型参数:

K - type of key.

N - type of namespace.

S - type of value.

所有已实现的接口:

Iterable<StateEntry<K,N,S>>

public class NestedStateMap<K,N,S>
extends StateMap<K,N,S>

This implementation of StateMap uses nested HashMap objects.

构造器概要

构造器

构造器和说明
NestedStateMap() Constructs a new NestedStateMap.

方法概要

限定符和类型	方法和说明
boolean	containsKey(K key, N namespace) Returns whether this map contains the specified key/namespace composite key.
S	get(K key, N namespace) Returns the state for the composite of active key and given namespace.
java.util.stream.Stream<K>	getKeys(N namespace)
Map<N,Map<K,S>>	getNamespaceMap()
InternalKvState.StateIncrementalVisitor<K,N,S>	getStateIncrementalVisitor(int recommendedMaxNumberOfReturnedRecords)
Iterator<StateEntry<K,N,S>>	iterator()
void	put(K key, N namespace, S state) Maps the specified key/namespace composite key to the specified value.
S	putAndGetOld(K key, N namespace, S state) Maps the composite of active key and given namespace to the specified state.
void	remove(K key, N namespace) Removes the mapping for the composite of active key and given namespace.
S	removeAndGetOld(K key, N namespace) Removes the mapping for the composite of active key and given namespace, returning the state that was found under the entry.
int	size() Returns the total number of entries in this StateMap.
int	sizeOfNamespace(Object namespace)
StateMapSnapshot<K,N,S,? extends StateMap<K,N,S>>	stateSnapshot() Creates a snapshot of this StateMap, to be written in checkpointing.
<T> void	transform(K key, N namespace, T value, StateTransformationFunction<S,T> transformation) Applies the given StateTransformationFunction to the state (1st input argument), using the given value as second input argument.

从类继承的方法 org.apache.flink.runtime.state.heap.StateMap

isEmpty, releaseSnapshot

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

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

从接口继承的方法 java.lang.Iterable

forEach, spliterator

构造器详细资料

NestedStateMap

public NestedStateMap()

Constructs a new NestedStateMap.

方法详细资料

size

public int size()

从类复制的说明: StateMap

Returns the total number of entries in this StateMap.

指定者:

size 在类中 StateMap<K,N,S>

返回:

the number of entries in this StateMap.

get

public S get(K key,
             N namespace)

从类复制的说明: StateMap

Returns the state for the composite of active key and given namespace.

指定者:

get 在类中 StateMap<K,N,S>

参数:

key - the key. Not null.

namespace - the namespace. Not null.

返回:

the state of the mapping with the specified key/namespace composite key, or null if no mapping for the specified key is found.

containsKey

public boolean containsKey(K key,
                           N namespace)

从类复制的说明: StateMap

Returns whether this map contains the specified key/namespace composite key.

指定者:

containsKey 在类中 StateMap<K,N,S>

参数:

key - the key in the composite key to search for. Not null.

namespace - the namespace in the composite key to search for. Not null.

返回:

true if this map contains the specified key/namespace composite key, false otherwise.

put

public void put(K key,
                N namespace,
                S state)

从类复制的说明: StateMap

Maps the specified key/namespace composite key to the specified value. This method should be preferred over #putAndGetOld(K, N, S) (Namespace, State)} when the caller is not interested in the old state.

指定者:

put 在类中 StateMap<K,N,S>

参数:

key - the key. Not null.

namespace - the namespace. Not null.

state - the state. Can be null.

putAndGetOld

public S putAndGetOld(K key,
                      N namespace,
                      S state)

从类复制的说明: StateMap

Maps the composite of active key and given namespace to the specified state. Returns the previous state that was registered under the composite key.

指定者:

putAndGetOld 在类中 StateMap<K,N,S>

参数:

key - the key. Not null.

namespace - the namespace. Not null.

state - the state. Can be null.

返回:

the state of any previous mapping with the specified key or null if there was no such mapping.

remove

public void remove(K key,
                   N namespace)

从类复制的说明: StateMap

Removes the mapping for the composite of active key and given namespace. This method should be preferred over #removeAndGetOld(K, N) when the caller is not interested in the old state.

指定者:

remove 在类中 StateMap<K,N,S>

参数:

key - the key of the mapping to remove. Not null.

namespace - the namespace of the mapping to remove. Not null.

removeAndGetOld

public S removeAndGetOld(K key,
                         N namespace)

从类复制的说明: StateMap

Removes the mapping for the composite of active key and given namespace, returning the state that was found under the entry.

指定者:

removeAndGetOld 在类中 StateMap<K,N,S>

参数:

key - the key of the mapping to remove. Not null.

namespace - the namespace of the mapping to remove. Not null.

返回:

the state of the removed mapping or null if no mapping for the specified key was found.

transform

public <T> void transform(K key,
                          N namespace,
                          T value,
                          StateTransformationFunction<S,T> transformation)
                   throws Exception

从类复制的说明: StateMap

Applies the given StateTransformationFunction to the state (1st input argument), using the given value as second input argument. The result of StateTransformationFunction.apply(Object, Object) is then stored as the new state. This function is basically an optimization for get-update-put pattern.

指定者:

transform 在类中 StateMap<K,N,S>

参数:

key - the key. Not null.

namespace - the namespace. Not null.

value - the value to use in transforming the state. Can be null.

transformation - the transformation function.

抛出:

Exception - if some exception happens in the transformation function.

iterator

public Iterator<StateEntry<K,N,S>> iterator()

getKeys

public java.util.stream.Stream<K> getKeys(N namespace)

指定者:

getKeys 在类中 StateMap<K,N,S>

getStateIncrementalVisitor

public InternalKvState.StateIncrementalVisitor<K,N,S> getStateIncrementalVisitor(int recommendedMaxNumberOfReturnedRecords)

指定者:

getStateIncrementalVisitor 在类中 StateMap<K,N,S>

sizeOfNamespace

public int sizeOfNamespace(Object namespace)

指定者:

sizeOfNamespace 在类中 StateMap<K,N,S>

stateSnapshot

@Nonnull
public StateMapSnapshot<K,N,S,? extends StateMap<K,N,S>> stateSnapshot()

从类复制的说明: StateMap

Creates a snapshot of this StateMap, to be written in checkpointing. Users should call StateMap.releaseSnapshot(StateMapSnapshot) after using the returned object.

指定者:

stateSnapshot 在类中 StateMap<K,N,S>

返回:

a snapshot from this StateMap, for checkpointing.

getNamespaceMap

public Map<N,Map<K,S>> getNamespaceMap()