org.apache.kafka.server.immutable

Interface ImmutableMap<K,V>

Type Parameters:

K - the key type

V - the value type

All Superinterfaces:

Map<K,V>

All Known Implementing Classes:

PCollectionsImmutableMap

public interface ImmutableMap<K,V>
extends Map<K,V>

A persistent Hash-based Map wrapper. java.util.Map methods that mutate in-place will throw UnsupportedOperationException

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Modifier and Type	Method and Description
static <K,V> ImmutableMap<K,V>	empty()
ImmutableMap<K,V>	removed(K key)
static <K,V> ImmutableMap<K,V>	singleton(K key, V value)
ImmutableMap<K,V>	updated(K key, V value)

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

empty

static <K,V> ImmutableMap<K,V> empty()

Type Parameters:

K - the key type

V - the value type

Returns:

a wrapped hash-based persistent map that is empty

singleton

static <K,V> ImmutableMap<K,V> singleton(K key,
                                         V value)

Type Parameters:

K - the key type

V - the value type

Parameters:

key - the key

value - the value

Returns:

a wrapped hash-based persistent map that has a single mapping

updated

ImmutableMap<K,V> updated(K key,
                          V value)

Parameters:

key - the key

value - the value

Returns:

a wrapped persistent map that differs from this one in that the given mapping is added (if necessary)

removed

ImmutableMap<K,V> removed(K key)

Parameters:

key - the key

Returns:

a wrapped persistent map that differs from this one in that the given mapping is removed (if necessary)