avail/avail.utility.structures/EnumMap

EnumMap

class EnumMap<K : Enum<K>, V : Any>(enums: Array<K>, sourceValues: Array<V?>) : MutableMap<K, V>

An EnumMap is a Map implementation for use with enum type keys only. All of the keys in an EnumMap must come from a single enum that is specified, explicitly as the first parameterized type. EnumMaps are represented internally as arrays. Enum maps are maintained in the natural order of their keys (Enum.ordinals).

This map does not support nulls as valid values. A key-value pair where the value is null is indicative that the "key" is not present.

Author

Richard Arriaga

Parameters

The type of Enum keys maintained by this EnumMap

The type of the values stored in this EnumMap.

enums

The Array of Enums, in Enum.ordinal order of all the Enum values represented in the Enum. It is expected that all enum values will be present.

sourceValues

The Array of values stored in this Enum.

Constructors

EnumMap

constructor(enums: Array<K>)

Construct an EnumMap.

constructor(enums: Array<K>, sourceValues: Array<V?>)

Construct an EnumMap.

Types

Companion

object Companion

Properties

entries

open override val entries: MutableSet<MutableMap.MutableEntry<K, V>>

keys

open override val keys: MutableSet<K>

size

open override val size: Int

values

open override val values: MutableCollection<V>

The Array of values stored in this Enum. null values are not allowed as a null value indicates the absence of a value.

Functions

clear

open override fun clear()

Removes all elements from this EnumMap.

compute

open fun compute(p0: K, p1: BiFunction<in K, in V?, out V?>): V?

computeIfAbsent

open fun computeIfAbsent(p0: K, p1: Function<in K, out V>): V

computeIfPresent

open fun computeIfPresent(p0: K, p1: BiFunction<in K, in V, out V?>): V?

containsKey

open override fun containsKey(key: K): Boolean

containsValue

open override fun containsValue(value: V): Boolean

forEach

open fun forEach(p0: BiConsumer<in K, in V>)

get

open operator override fun get(key: K): V?

getOrDefault

open fun getOrDefault(key: K, defaultValue: V): V

getOrNull

fun getOrNull(key: K): V?

Answer the value if present, otherwise null.

getOrPut

fun getOrPut(key: K, mappingFunction: (K) -> V): V

Answer the value at the provided key. If no value is available (null is at Enum.ordinal in the sourceValues array), evaluate the lambda, place the resulting value in this map at that key, then answer the value.

isEmpty

open override fun isEmpty(): Boolean

merge