squidpony.squidmath

Class EnumOrderedSet<K extends java.lang.Enum<?>>

java.lang.Object

squidpony.squidmath.OrderedSet<K>

squidpony.squidmath.EnumOrderedSet<K>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<K>, java.util.Collection<K>, java.util.Set<K>, java.util.SortedSet<K>

public class EnumOrderedSet<K extends java.lang.Enum<?>>
extends OrderedSet<K>

A simple Set of Enum items (which are already unique if used in a normal Set) that keeps insertion order. By inheriting from OrderedSet, it gets features not present in normal JDK Sets, such as retrieval of random items with OrderedSet.randomItem(IRNG), iteration in insertion order instead of always using enum declaration order (order can be shuffled with OrderedSet.shuffle(IRNG) or reordered with OrderedSet.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 EnumOrderedMap.
Created by Tommy Ettinger on 10/21/2017.

See Also:

Serialized Form

Field Summary

Fields inherited from class squidpony.squidmath.OrderedSet

containsNull, DEFAULT_INITIAL_SIZE, DEFAULT_LOAD_FACTOR, f, FAST_LOAD_FACTOR, hasher, key, mask, maxFill, n, order, size, VERY_FAST_LOAD_FACTOR

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class squidpony.squidmath.OrderedSet

add, addAll, addAll, addAndMoveToFirst, addAndMoveToLast, addAt, addOrGet, alter, alterAt, arraySize, clear, clone, comparator, contains, containsAll, equals, first, fixOrder, fixOrder, get, getAt, hash64, hashCode, headSet, indexOf, isEmpty, iterator, last, maxFill, maxFill, positionOf, randomItem, rehash, rem, remove, removeAll, removeAt, removeFirst, removeLast, reorder, retainAll, reverse, shiftKeys, shuffle, size, sort, sort, subSet, swap, swapIndices, tailSet, toArray, toArray, trim, trim

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.SortedSet

spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

EnumOrderedSet

public EnumOrderedSet()

EnumOrderedSet

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

EnumOrderedSet

public EnumOrderedSet(K enumObject)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class OrderedSet<K extends java.lang.Enum<?>>