org.apache.flink.queryablestate.client.state

Class ImmutableMapState<K,V>

java.lang.Object

org.apache.flink.queryablestate.client.state.ImmutableMapState<K,V>

All Implemented Interfaces:

MapState<K,V>, State

public final class ImmutableMapState<K,V>
extends Object
implements MapState<K,V>

A read-only MapState that does not allow for modifications.

This is the result returned when querying Flink's keyed state using the Queryable State Client and providing an MapStateDescriptor.

Field Summary

Fields

Modifier and Type	Field and Description
protected static UnsupportedOperationException	MODIFICATION_ATTEMPT_ERROR

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.
static <K,V,T,S extends State> S	createState(StateDescriptor<S,T> stateDescriptor, byte[] serializedState)
Iterable<Map.Entry<K,V>>	entries() Returns all the mappings in the state in a Collections.unmodifiableSet(Set).
V	get(K key) Returns the current value associated with the given key.
Iterator<Map.Entry<K,V>>	iterator() Iterates over all the mappings in the state.
Iterable<K>	keys() Returns all the keys in the state in a Collections.unmodifiableSet(Set).
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.
Iterable<V>	values() Returns all the values in the state in a Collections.unmodifiableCollection(Collection).

Methods inherited from class java.lang.Object

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

Field Detail

MODIFICATION_ATTEMPT_ERROR

protected static final UnsupportedOperationException MODIFICATION_ATTEMPT_ERROR

Method Detail

get

public V get(K key)

Description copied from interface: MapState

Returns the current value associated with the given key.

Specified by:

get in interface MapState<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: MapState

Associates a new value with the given key.

Specified by:

put in interface MapState<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: MapState

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

Specified by:

putAll in interface MapState<K,V>

Parameters:

map - The mappings to be stored in this state

remove

public void remove(K key)

Description copied from interface: MapState

Deletes the mapping of the given key.

Specified by:

remove in interface MapState<K,V>

Parameters:

key - The key of the mapping

contains

public boolean contains(K key)

Description copied from interface: MapState

Returns whether there exists the given mapping.

Specified by:

contains in interface MapState<K,V>

Parameters:

key - The key of the mapping

Returns:

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

entries

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

Returns all the mappings in the state in a Collections.unmodifiableSet(Set).

Specified by:

entries in interface MapState<K,V>

Returns:

A read-only iterable view of all the key-value pairs in the state.

keys

public Iterable<K> keys()

Returns all the keys in the state in a Collections.unmodifiableSet(Set).

Specified by:

keys in interface MapState<K,V>

Returns:

A read-only iterable view of all the keys in the state.

values

public Iterable<V> values()

Returns all the values in the state in a Collections.unmodifiableCollection(Collection).

Specified by:

values in interface MapState<K,V>

Returns:

A read-only iterable view of all the values in the state.

iterator

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

Iterates over all the mappings in the state. The iterator cannot remove elements.

Specified by:

iterator in interface MapState<K,V>

Returns:

A read-only iterator over all the mappings in the state.

clear

public void clear()

Description copied from interface: State

Removes the value mapped under the current key.

Specified by:

clear in interface State

createState

public static <K,V,T,S extends State> S createState(StateDescriptor<S,T> stateDescriptor,
                                                    byte[] serializedState)
                                             throws IOException

Throws:

IOException