org.apache.flink.runtime.state

Class HeapBroadcastState<K,V>

java.lang.Object

org.apache.flink.runtime.state.HeapBroadcastState<K,V>

Type Parameters:

K - The key type of the elements in the Broadcast State.

V - The value type of the elements in the Broadcast State.

All Implemented Interfaces:

BroadcastState<K,V>, ReadOnlyBroadcastState<K,V>, State, BackendWritableBroadcastState<K,V>

public class HeapBroadcastState<K,V>
extends Object
implements BackendWritableBroadcastState<K,V>

A Broadcast State backed a heap-based Map.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes the value mapped under the current key.
boolean	contains(K key) Returns whether there exists the given mapping.
HeapBroadcastState<K,V>	deepCopy()
Iterable<Map.Entry<K,V>>	entries() Returns all the mappings in the state.
V	get(K key) Returns the current value associated with the given key.
MapSerializer<K,V>	getInternalMapCopySerializer()
RegisteredBroadcastStateBackendMetaInfo<K,V>	getStateMetaInfo()
Iterable<Map.Entry<K,V>>	immutableEntries() Returns an immutable Iterable over the entries in the state.
Iterator<Map.Entry<K,V>>	iterator() Iterates over all the mappings in the state.
void	put(K key, V value) Associates a new value with the given key.
void	putAll(Map<K,V> map) Copies all of the mappings from the given map into the state.
void	remove(K key) Deletes the mapping of the given key.
void	setStateMetaInfo(RegisteredBroadcastStateBackendMetaInfo<K,V> stateMetaInfo)
String	toString()
long	write(FSDataOutputStream out)

Methods inherited from class java.lang.Object

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

Method Detail

setStateMetaInfo

public void setStateMetaInfo(RegisteredBroadcastStateBackendMetaInfo<K,V> stateMetaInfo)

Specified by:

setStateMetaInfo in interface BackendWritableBroadcastState<K,V>

getStateMetaInfo

public RegisteredBroadcastStateBackendMetaInfo<K,V> getStateMetaInfo()

Specified by:

getStateMetaInfo in interface BackendWritableBroadcastState<K,V>

deepCopy

public HeapBroadcastState<K,V> deepCopy()

Specified by:

deepCopy in interface BackendWritableBroadcastState<K,V>

clear

public void clear()

Description copied from interface: State

Removes the value mapped under the current key.

Specified by:

clear in interface State

toString

public String toString()

Overrides:

toString in class Object

write

public long write(FSDataOutputStream out)
           throws IOException

Specified by:

write in interface BackendWritableBroadcastState<K,V>

Throws:

IOException

get

public V get(K key)

Description copied from interface: ReadOnlyBroadcastState

Returns the current value associated with the given key.

The user code must not modify the value returned, as this can lead to inconsistent states.

Specified by:

get in interface ReadOnlyBroadcastState<K,V>

Parameters:

key - The key of the mapping

Returns:

The value of the mapping with the given key

put

public void put(K key,
                V value)

Description copied from interface: BroadcastState

Associates a new value with the given key.

Specified by:

put in interface BroadcastState<K,V>

Parameters:

key - The key of the mapping

value - The new value of the mapping

putAll

public void putAll(Map<K,V> map)

Description copied from interface: BroadcastState

Copies all of the mappings from the given map into the state.

Specified by:

putAll in interface BroadcastState<K,V>

Parameters:

map - The mappings to be stored in this state

remove

public void remove(K key)

Description copied from interface: BroadcastState

Deletes the mapping of the given key.

Specified by:

remove in interface BroadcastState<K,V>

Parameters:

key - The key of the mapping

contains

public boolean contains(K key)

Description copied from interface: ReadOnlyBroadcastState

Returns whether there exists the given mapping.

Specified by:

contains in interface ReadOnlyBroadcastState<K,V>

Parameters:

key - The key of the mapping

Returns:

True if there exists a mapping whose key equals to the given key

iterator

public Iterator<Map.Entry<K,V>> iterator()

Description copied from interface: BroadcastState

Iterates over all the mappings in the state.

Specified by:

iterator in interface BroadcastState<K,V>

Returns:

An iterator over all the mappings in the state

entries

public Iterable<Map.Entry<K,V>> entries()

Description copied from interface: BroadcastState

Returns all the mappings in the state.

Specified by:

entries in interface BroadcastState<K,V>

Returns:

An iterable view of all the key-value pairs in the state.

immutableEntries

public Iterable<Map.Entry<K,V>> immutableEntries()

Description copied from interface: ReadOnlyBroadcastState

Returns an immutable Iterable over the entries in the state.

The user code must not modify the entries of the returned immutable iterator, as this can lead to inconsistent states.

Specified by:

immutableEntries in interface ReadOnlyBroadcastState<K,V>

getInternalMapCopySerializer

@VisibleForTesting
public MapSerializer<K,V> getInternalMapCopySerializer()