squidpony.squidmath

Class EnumOrderedMap<K extends java.lang.Enum<?>,V>

java.lang.Object

squidpony.squidmath.OrderedMap<K,V>

squidpony.squidmath.EnumOrderedMap<K,V>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<K,V>, java.util.SortedMap<K,V>

public class EnumOrderedMap<K extends java.lang.Enum<?>,V>
extends OrderedMap<K,V>

A simple alternative to EnumMap that has a zero-argument constructor (which makes serialization easier) but is a little less efficient. However, it supports more features by inheriting from OrderedMap, such as retrieval of random keys or values with OrderedMap.randomKey(IRNG) and OrderedMap.randomValue(IRNG), iteration in insertion order instead of always using enum declaration order (order can be shuffled with OrderedMap.shuffle(IRNG) or reordered with OrderedMap.reorder(int...)), and a little more. The implementation is nearly trivial due to how OrderedMap allows customization of hashing strategy with its IHasher option, and this class always uses a specific custom IHasher to hash Enum values by their ordinal. This IHasher is shared with EnumOrderedSet.
Created by Tommy Ettinger on 10/21/2017.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class squidpony.squidmath.OrderedMap

OrderedMap.KeyIterator, OrderedMap.KeySet, OrderedMap.MapEntrySet, OrderedMap.ValueCollection, OrderedMap.ValueIterator

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

java.util.Map.Entry<K,V>

Field Summary

Fields inherited from class squidpony.squidmath.OrderedMap

containsNullKey, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, defRetValue, entries, f, FAST_LOAD_FACTOR, hasher, key, keys, mask, maxFill, n, order, size, value, values, VERY_FAST_LOAD_FACTOR

Constructor Summary

Constructors

Constructor and Description
EnumOrderedMap()
EnumOrderedMap(java.lang.Class<K> enumClass)
EnumOrderedMap(K enumObject)

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()

Methods inherited from class squidpony.squidmath.OrderedMap

alter, alterAt, alterAtCarefully, alterCarefully, arraySize, clear, clone, comparator, containsKey, containsValue, defaultReturnValue, defaultReturnValue, ensureCapacity, entryAt, entrySet, equals, firstKey, fixOrder, fixOrder, get, getAndMoveToFirst, getAndMoveToLast, getAt, getMany, getOrDefault, hash64, hashCode, headMap, indexOf, isEmpty, keyAt, keysAsOrderedSet, keySet, lastKey, makeMap, makeMap, maxFill, objectUnwrap, objectUnwrap, positionOf, put, putAll, putAll, putAndMoveToFirst, putAndMoveToLast, putAt, putIfAbsent, putPairs, randomEntry, randomKey, randomValue, rehash, remove, remove, removeAt, removeEntry, removeFirst, removeLast, removeNullEntry, reorder, replace, replace, reverse, setAt, shiftKeys, shuffle, size, sort, sort, sortByValue, sortByValue, subMap, swap, swapIndices, tailMap, trim, trim, unwrap, unwrap, values, valuesAsList

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, merge, replaceAll

Constructor Detail

EnumOrderedMap

public EnumOrderedMap()

EnumOrderedMap

public EnumOrderedMap(java.lang.Class<K> enumClass)

EnumOrderedMap

public EnumOrderedMap(K enumObject)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class OrderedMap<K extends java.lang.Enum<?>,V>