Package com.github.tommyettinger.ds

Class EnumIntOrderedMap

java.lang.Object

com.github.tommyettinger.ds.EnumIntMap

com.github.tommyettinger.ds.EnumIntOrderedMap

All Implemented Interfaces:

Arrangeable, Ordered<Enum<?>>, Iterable<EnumIntMap.Entry>

public class EnumIntOrderedMap
extends EnumIntMap
implements Ordered<Enum<?>>

An insertion-ordered map where the keys are Enums and values are primitive ints. Null keys are not allowed. Unlike EnumMap, this does not require a Class at construction time, which can be useful for serialization purposes. No allocation is done unless this is changing its table size and/or key universe.
This class never actually hashes keys in its primary operations (get(), put(), remove(), containsKey(), etc.), since it can rely on keys having an Enum type, and so having Enum.ordinal() available. The ordinal allows constant-time access to a guaranteed-unique int that will always be non-negative and less than the size of the key universe. The table of possible values always starts sized to fit exactly as many values as there are keys in the key universe.
The key universe is an important concept here; it is simply an array of all possible Enum values the EnumIntOrderedMap can use as keys, in the specific order they are declared. You almost always get a key universe by calling MyEnum.values(), but you can also use Class.getEnumConstants() for an Enum class. You can and generally should reuse key universes in order to avoid allocations and/or save memory; the constructor EnumIntOrderedMap(Enum[]) (with no values given) creates an empty EnumIntOrderedMap with a given key universe. If you need to use the zero-argument constructor, you can, and the key universe will be obtained from the first key placed into the EnumIntOrderedMap. You can also set the key universe with clearToUniverse(Enum[]), in the process of clearing the map.
This class tries to be as compatible as possible with EnumMap while using primitive keys, though this expands on that where possible.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EnumIntOrderedMap.OrderedMapEntries
static class	EnumIntOrderedMap.OrderedMapKeys
static class	EnumIntOrderedMap.OrderedMapValues

Nested classes/interfaces inherited from class com.github.tommyettinger.ds.EnumIntMap

EnumIntMap.Entries, EnumIntMap.Entry, EnumIntMap.EntryIterator, EnumIntMap.KeyIterator, EnumIntMap.Keys, EnumIntMap.MapIterator, EnumIntMap.ValueIterator, EnumIntMap.Values

Nested classes/interfaces inherited from interface com.github.tommyettinger.ds.Arrangeable

Arrangeable.ArrangeableList<T>

Nested classes/interfaces inherited from interface com.github.tommyettinger.ds.Ordered

Ordered.OfBoolean, Ordered.OfByte, Ordered.OfChar, Ordered.OfDouble, Ordered.OfFloat, Ordered.OfInt, Ordered.OfLong, Ordered.OfShort

Field Summary

Fields

Modifier and Type	Field	Description
protected final ObjectList<Enum<?>>	ordering

Fields inherited from class com.github.tommyettinger.ds.EnumIntMap

defaultValue, entries1, entries2, keys, keys1, keys2, values1, values2, valueTable

Constructor Summary

Constructors

Constructor	Description
EnumIntOrderedMap()	Empty constructor; using this will postpone creating the key universe and allocating the value table until put(java.lang.Enum<?>, int) is first called (potentially indirectly).
EnumIntOrderedMap(EnumIntOrderedMap map)	Creates a new map identical to the specified EnumIntOrderedMap.
EnumIntOrderedMap(EnumIntOrderedMap other, int offset, int count)	Creates a new map by copying count items from the given EnumIntOrderedMap, starting at offset in that Map, into this.
EnumIntOrderedMap(EnumIntOrderedMap other, int offset, int count, OrderType type)	Creates a new map by copying count items from the given EnumIntOrderedMap, starting at offset in that Map, into this.
EnumIntOrderedMap(EnumIntOrderedMap map, OrderType type)	Creates a new map identical to the specified EnumIntOrderedMap.
EnumIntOrderedMap(OrderType type)	Constructor that only specifies an OrderType; using this will postpone creating the key universe and allocating the value table until put(java.lang.Enum<?>, int) is first called (potentially indirectly).
EnumIntOrderedMap(Class<? extends Enum<?>> universeClass)	Initializes this map so that it has exactly enough capacity as needed to contain each Enum constant defined by the Class universeClass, assuming universeClass is non-null.
EnumIntOrderedMap(Class<? extends Enum<?>> universeClass, OrderType type)	Initializes this map so that it has exactly enough capacity as needed to contain each Enum constant defined by the Class universeClass, assuming universeClass is non-null.
EnumIntOrderedMap(Enum<?>[] universe)	Initializes this map so that it has exactly enough capacity as needed to contain each Enum constant defined in universe, assuming universe stores every possible constant in one Enum type.
EnumIntOrderedMap(Enum<?>[] keys, int[] values)	Given two side-by-side arrays, one of Enum keys, one of int values, this constructs a map and inserts each pair of key and value into it.
EnumIntOrderedMap(Enum<?>[] keys, int[] values, OrderType type)	Given two side-by-side arrays, one of Enum keys, one of int values, this constructs a map and inserts each pair of key and value into it.
EnumIntOrderedMap(Enum<?>[] universe, OrderType type)	Initializes this map so that it has exactly enough capacity as needed to contain each Enum constant defined in universe, assuming universe stores every possible constant in one Enum type.
EnumIntOrderedMap(Collection<? extends Enum<?>> keys, PrimitiveCollection.OfInt values)	Given two side-by-side collections, one of Enum keys, one of int values, this constructs a map and inserts each pair of key and value into it.
EnumIntOrderedMap(Collection<? extends Enum<?>> keys, PrimitiveCollection.OfInt values, OrderType type)	Given two side-by-side collections, one of Enum keys, one of int values, this constructs a map and inserts each pair of key and value into it.

Method Summary

Modifier and Type	Method	Description
boolean	alter(Enum<?> before, Enum<?> after)	Changes the key before to after without changing its position in the order or its value.
boolean	alterAt(int index, Enum<?> after)	Changes the key at the given index in the order to after, without changing the ordering of other entries or any values.
StringBuilder	appendTo(StringBuilder sb, String entrySeparator, String keyValueSeparator, boolean braces, Appender<Enum<?>> keyAppender, IntAppender valueAppender)	Appends to a StringBuilder from the contents of this EnumIntOrderedMap, but uses the given Appender and IntAppender to convert each key and each value to a customizable representation and append them to a StringBuilder.
void	clear()	Removes all the elements from this map.
void	clearToUniverse(Class<? extends Enum<?>> universe)	Removes all the elements from this map and can reset the universe of possible Enum items this can hold.
void	clearToUniverse(Enum<?>[] universe)	Removes all the elements from this map and can reset the universe of possible Enum items this can hold.
EnumIntMap.Entries	entrySet()	Returns a Set of Map.Entry, containing the entries in the map.
int	getAndIncrement(Enum<?> key, int defaultValue, int increment)	Returns the key's current value and increments the stored value.
int	getAt(int index)	Gets the int value at the given index in the insertion order.
EnumIntMap.EntryIterator	iterator()	Reuses the iterator of the reused EnumIntMap.Entries produced by entrySet(); does not permit nested iteration.
Enum<?>	keyAt(int index)	Gets the K key at the given index in the insertion order.
EnumIntMap.Keys	keySet()	Returns a Set view of the keys contained in this map.
static EnumIntOrderedMap	of()	Constructs an empty map.
static EnumIntOrderedMap	of(Enum<?> key0, Number value0, Object... rest)	Constructs a map given alternating keys and values.
ObjectList<Enum<?>>	order()	Gets the ObjectList of keys in the order this class will iterate through them.
static EnumIntOrderedMap	parse(String str, String entrySeparator, String keyValueSeparator, PartialParser<Enum<?>> keyParser)	Creates a new map by parsing all of str with the given PartialParser for keys, with entries separated by entrySeparator, such as ", " and the keys separated from values by keyValueSeparator, such as "=".
static EnumIntOrderedMap	parse(String str, String entrySeparator, String keyValueSeparator, PartialParser<Enum<?>> keyParser, boolean brackets)	Creates a new map by parsing all of str (or if brackets is true, all but the first and last chars) with the given PartialParser for keys, with entries separated by entrySeparator, such as ", " and the keys separated from values by keyValueSeparator, such as "=".
static EnumIntOrderedMap	parse(String str, String entrySeparator, String keyValueSeparator, PartialParser<Enum<?>> keyParser, int offset, int length)	Creates a new map by parsing the given subrange of str with the given PartialParser for keys, with entries separated by entrySeparator, such as ", " and the keys separated from values by keyValueSeparator, such as "=".
int	put(Enum<?> key, int value)	Returns the old value associated with the specified key, or this map's EnumIntMap.defaultValue if there was no prior value.
int	put(Enum<?> key, int value, int index)	Puts the given key and value into this map at the given index in its order.
void	putAll(int insertionIndex, EnumIntOrderedMap other, int offset, int count)	Adds up to count entries, starting from offset, in the map other to this set, inserting starting at insertionIndex in the iteration order.
void	putAll(EnumIntOrderedMap map)	Puts every key-value pair in the given map into this, with the values from the given map overwriting the previous values if two keys are identical.
void	putAll(EnumIntOrderedMap other, int offset, int count)	Adds up to count entries, starting from offset, in the map other to this set, inserting at the end of the iteration order.
void	putAll(ObjectIntOrderedMap<Enum<?>> map)	Copies all the mappings from the specified map to this map (optional operation).
int	putOrDefault(Enum<?> key, int value, int defaultValue)	Acts like EnumIntMap.put(Enum, int), but uses the specified defaultValue instead of the default value for this EnumIntMap.
int	remove(Object key)
int	removeAt(int index)	Removes the entry at the given index in the order, returning the value of that entry.
void	removeRange(int start, int end)	Removes the items between the specified start index, inclusive, and end index, exclusive.
int	setAt(int index, int v)	Changes the value at a specified index in the iteration order to v, without changing keys at all.
void	sort()	Sorts this EnumIntOrderedMap in-place by the keys' natural ordering.
void	sort(Comparator<? super Enum<?>> comp)	Sorts this EnumIntOrderedMap in-place by the given Comparator used on the keys.
void	sortByValue(IntComparator comp)	Sorts this EnumIntOrderedMap in-place by the given IntComparator used on the values.
void	truncate(int newSize)	Reduces the size of the map to the specified size.
EnumIntMap.Values	values()	Returns a PrimitiveCollection for the values in the map.
static EnumIntOrderedMap	with()	Constructs an empty map.
static EnumIntOrderedMap	with(Enum<?> key0, Number value0)	Constructs a single-entry map given one key and one value.
static EnumIntOrderedMap	with(Enum<?> key0, Number value0, Enum<?> key1, Number value1)	Constructs a map given alternating keys and values.
static EnumIntOrderedMap	with(Enum<?> key0, Number value0, Enum<?> key1, Number value1, Enum<?> key2, Number value2)	Constructs a map given alternating keys and values.
static EnumIntOrderedMap	with(Enum<?> key0, Number value0, Enum<?> key1, Number value1, Enum<?> key2, Number value2, Enum<?> key3, Number value3)	Constructs a map given alternating keys and values.
static EnumIntOrderedMap	with(Enum<?> key0, Number value0, Object... rest)	Constructs a map given alternating keys and values.
static EnumIntOrderedMap	withPrimitive()	Constructs an empty map.
static EnumIntOrderedMap	withPrimitive(Enum<?> key0, int value0)	Constructs a single-entry map given one key and one value.
static EnumIntOrderedMap	withPrimitive(Enum<?> key0, int value0, Enum<?> key1, int value1)	Constructs a map given alternating keys and values.
static EnumIntOrderedMap	withPrimitive(Enum<?> key0, int value0, Enum<?> key1, int value1, Enum<?> key2, int value2)	Constructs a map given alternating keys and values.
static EnumIntOrderedMap	withPrimitive(Enum<?> key0, int value0, Enum<?> key1, int value1, Enum<?> key2, int value2, Enum<?> key3, int value3)	Constructs a map given alternating keys and values.

Methods inherited from class com.github.tommyettinger.ds.EnumIntMap

appendTo, combine, combine, computeIfAbsent, containsKey, containsValue, equals, findKey, get, getDefaultValue, getOrDefault, getUniverse, hashCode, isEmpty, notEmpty, putAll, putAll, putAll, putAll, putAll, putAll, putLegible, putLegible, putLegible, putLegible, putPairs, remove, replace, setDefaultValue, size, toString, toString, toString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.github.tommyettinger.ds.Arrangeable

rearrange, shuffle, size

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface com.github.tommyettinger.ds.Ordered

getOrderType, random, random, reverse, selectRanked, selectRankedIndex, shuffle, swap

Field Details

ordering

protected final ObjectList<Enum<?>> ordering

Constructor Details

EnumIntOrderedMap

public EnumIntOrderedMap(OrderType type)

Constructor that only specifies an OrderType; using this will postpone creating the key universe and allocating the value table until put(java.lang.Enum<?>, int) is first called (potentially indirectly). You can also use clearToUniverse(java.lang.Enum<?>[]) to set the key universe and value table.

Parameters:

type - either OrderType.BAG to use unreliable ordering with faster deletion, or anything else to use a list type that takes longer to delete but maintains insertion order reliably

EnumIntOrderedMap

public EnumIntOrderedMap(Enum<?>[] universe,
 OrderType type)

Initializes this map so that it has exactly enough capacity as needed to contain each Enum constant defined in universe, assuming universe stores every possible constant in one Enum type. This map will start empty. You almost always obtain universe from calling values() on an Enum type, and you can share one reference to one Enum array across many EnumIntOrderedMap instances if you don't modify the shared array. Sharing the same universe helps save some memory if you have (very) many EnumIntOrderedMap instances.

Parameters:

universe - almost always, the result of calling values() on an Enum type; used directly, not copied

type - either OrderType.BAG to use unreliable ordering with faster deletion, or anything else to use a list type that takes longer to delete but maintains insertion order reliably

EnumIntOrderedMap

public EnumIntOrderedMap(Class<? extends Enum<?>> universeClass,
 OrderType type)

Initializes this map so that it has exactly enough capacity as needed to contain each Enum constant defined by the Class universeClass, assuming universeClass is non-null. This simply calls EnumIntOrderedMap(Enum[]) for convenience. Note that this constructor allocates a new array of Enum constants each time it is called, where if you use EnumIntOrderedMap(Enum[]), you can reuse an unmodified array to reduce allocations.

Parameters:

universeClass - the Class of an Enum type that defines the universe of valid Enum items this can hold

type - either OrderType.BAG to use unreliable ordering with faster deletion, or anything else to use a list type that takes longer to delete but maintains insertion order reliably

EnumIntOrderedMap

public EnumIntOrderedMap(EnumIntOrderedMap map,
 OrderType type)

Creates a new map identical to the specified EnumIntOrderedMap. This will share a key universe with the given EnumIntOrderedMap, if non-null. This overload allows specifying the OrderType independently of the one used in map.

Parameters:

map - an EnumIntOrderedMap to copy

type - either OrderType.BAG to use unreliable ordering with faster deletion, or anything else to use a list type that takes longer to delete but maintains insertion order reliably

EnumIntOrderedMap

public EnumIntOrderedMap(Enum<?>[] keys,
 int[] values,
 OrderType type)

Given two side-by-side arrays, one of Enum keys, one of int values, this constructs a map and inserts each pair of key and value into it. If keys and values have different lengths, this only uses the length of the smaller array.

Parameters:

keys - an array of Enum keys

values - an array of int values

type - either OrderType.BAG to use unreliable ordering with faster deletion, or anything else to use a list type that takes longer to delete but maintains insertion order reliably

EnumIntOrderedMap

public EnumIntOrderedMap(Collection<? extends Enum<?>> keys,
 PrimitiveCollection.OfInt values,
 OrderType type)

Given two side-by-side collections, one of Enum keys, one of int values, this constructs a map and inserts each pair of key and value into it. If keys and values have different lengths, this only uses the length of the smaller collection.

Parameters:

keys - a Collection of Enum keys

values - a PrimitiveCollection of int values

type - either OrderType.BAG to use unreliable ordering with faster deletion, or anything else to use a list type that takes longer to delete but maintains insertion order reliably

EnumIntOrderedMap

public EnumIntOrderedMap(EnumIntOrderedMap other,
 int offset,
 int count,
 OrderType type)

Creates a new map by copying count items from the given EnumIntOrderedMap, starting at offset in that Map, into this. This overload allows specifying the OrderType independently of the one used in other.

Parameters:

other - another EnumIntOrderedMap

offset - the first index in other's ordering to draw an item from

count - how many items to copy from other

type - either OrderType.BAG to use unreliable ordering with faster deletion, or anything else to use a list type that takes longer to delete but maintains insertion order reliably

EnumIntOrderedMap

public EnumIntOrderedMap()

Empty constructor; using this will postpone creating the key universe and allocating the value table until put(java.lang.Enum<?>, int) is first called (potentially indirectly). You can also use clearToUniverse(java.lang.Enum<?>[]) to set the key universe and value table.

EnumIntOrderedMap

public EnumIntOrderedMap(Enum<?>[] universe)

Initializes this map so that it has exactly enough capacity as needed to contain each Enum constant defined in universe, assuming universe stores every possible constant in one Enum type. This map will start empty. You almost always obtain universe from calling values() on an Enum type, and you can share one reference to one Enum array across many EnumIntOrderedMap instances if you don't modify the shared array. Sharing the same universe helps save some memory if you have (very) many EnumIntOrderedMap instances.

Parameters:

universe - almost always, the result of calling values() on an Enum type; used directly, not copied

EnumIntOrderedMap

public EnumIntOrderedMap(Class<? extends Enum<?>> universeClass)

Initializes this map so that it has exactly enough capacity as needed to contain each Enum constant defined by the Class universeClass, assuming universeClass is non-null. This simply calls EnumIntOrderedMap(Enum[]) for convenience. Note that this constructor allocates a new array of Enum constants each time it is called, where if you use EnumIntOrderedMap(Enum[]), you can reuse an unmodified array to reduce allocations.

Parameters:

universeClass - the Class of an Enum type that defines the universe of valid Enum items this can hold

EnumIntOrderedMap

public EnumIntOrderedMap(EnumIntOrderedMap map)

Creates a new map identical to the specified EnumIntOrderedMap. This will share a key universe with the given EnumIntOrderedMap, if non-null. This overload uses the OrderType of the given map.

Parameters:

map - an EnumIntOrderedMap to copy

EnumIntOrderedMap

public EnumIntOrderedMap(Enum<?>[] keys,
 int[] values)

Given two side-by-side arrays, one of Enum keys, one of int values, this constructs a map and inserts each pair of key and value into it. If keys and values have different lengths, this only uses the length of the smaller array.

Parameters:

keys - an array of Enum keys

values - an array of int values

EnumIntOrderedMap

public EnumIntOrderedMap(Collection<? extends Enum<?>> keys,
 PrimitiveCollection.OfInt values)

Given two side-by-side collections, one of Enum keys, one of int values, this constructs a map and inserts each pair of key and value into it. If keys and values have different lengths, this only uses the length of the smaller collection.

Parameters:

keys - a Collection of Enum keys

values - a PrimitiveCollection of int values

EnumIntOrderedMap

public EnumIntOrderedMap(EnumIntOrderedMap other,
 int offset,
 int count)

Creates a new map by copying count items from the given EnumIntOrderedMap, starting at offset in that Map, into this. This overload uses the OrderType of the given map.

Parameters:

other - another EnumIntOrderedMap

offset - the first index in other's ordering to draw an item from

count - how many items to copy from other

Method Details

put

public int put(Enum<?> key,
 int value)

Returns the old value associated with the specified key, or this map's EnumIntMap.defaultValue if there was no prior value. If this EnumIntOrderedMap does not yet have a key universe and/or value table, this gets the key universe from key and uses it from now on for this EnumIntOrderedMap.

Overrides:

put in class EnumIntMap

Parameters:

key - the Enum key to try to place into this EnumIntOrderedMap

value - the int value to associate with key

Returns:

the previous value associated with key, or EnumIntMap.getDefaultValue() if the given key was not present

put

public int put(Enum<?> key,
 int value,
 int index)

Puts the given key and value into this map at the given index in its order. If the key is already present at a different index, it is moved to the given index and its value is set to the given value.

Parameters:

key - an Enum key; must not be null

value - a int value

index - the index in the order to place the given key and value; must be non-negative and less than EnumIntMap.size()

Returns:

the previous value associated with key, if there was one, or EnumIntMap.defaultValue otherwise

putOrDefault

public int putOrDefault(Enum<?> key,
 int value,
 int defaultValue)

Description copied from class: EnumIntMap

Acts like EnumIntMap.put(Enum, int), but uses the specified defaultValue instead of the default value for this EnumIntMap.

Overrides:

putOrDefault in class EnumIntMap

Parameters:

key - the Enum key to try to place into this EnumIntMap

value - the int value to associate with key

defaultValue - the int value to return if key was not already present

Returns:

the previous value associated with key, or the given defaultValue if the given key was not present

putAll

public void putAll(EnumIntOrderedMap map)

Puts every key-value pair in the given map into this, with the values from the given map overwriting the previous values if two keys are identical. This will put keys in the order of the given map.

Parameters:

map - a map with compatible key and value types; will not be modified

putAll

public void putAll(EnumIntOrderedMap other,
 int offset,
 int count)

Adds up to count entries, starting from offset, in the map other to this set, inserting at the end of the iteration order.

Parameters:

other - a non-null ordered map with the same type and compatible generic types

offset - the first index in other to use

count - how many indices in other to use

putAll

public void putAll(int insertionIndex,
 EnumIntOrderedMap other,
 int offset,
 int count)

Adds up to count entries, starting from offset, in the map other to this set, inserting starting at insertionIndex in the iteration order.

Parameters:

insertionIndex - where to insert into the iteration order

other - a non-null ordered map with the same type and compatible generic types

offset - the first index in other to use

count - how many indices in other to use

remove

public int remove(Object key)

Overrides:

remove in class EnumIntMap

removeAt

public int removeAt(int index)

Removes the entry at the given index in the order, returning the value of that entry.

Parameters:

index - the index of the entry to remove; must be at least 0 and less than EnumIntMap.size()

Returns:

the value of the removed entry

removeRange

public void removeRange(int start,
 int end)

Removes the items between the specified start index, inclusive, and end index, exclusive. Note that this takes different arguments than some other range-related methods; this needs a start index and an end index, rather than a count of items. This matches the behavior in the JDK collections.

Specified by:

removeRange in interface Ordered<Enum<?>>

Parameters:

start - the first index to remove, inclusive

end - the last index (after what should be removed), exclusive

truncate

public void truncate(int newSize)

Reduces the size of the map to the specified size. If the map is already smaller than the specified size, no action is taken.

Parameters:

newSize - the target size to try to reach by removing items, if smaller than the current size

putAll

public void putAll(ObjectIntOrderedMap<Enum<?>> map)

Copies all the mappings from the specified map to this map (optional operation). The effect of this call is equivalent to that of calling put(k, v) on this map once for each mapping from key k to value v in the specified map. The behavior of this operation is undefined if the specified map is modified while the operation is in progress.
Note that putAll(EnumIntOrderedMap) is more specific and can be more efficient by using the internal details of this class.

Parameters:

map - mappings to be stored in this map

Throws:

UnsupportedOperationException - if the putAll operation is not supported by this map

ClassCastException - if the class of a key or value in the specified map prevents it from being stored in this map

NullPointerException - if the specified map is null, or if this map does not permit null keys or values, and the specified map contains null keys or values

IllegalArgumentException - if some property of a key or value in the specified map prevents it from being stored in this map

getAndIncrement

public int getAndIncrement(Enum<?> key,
 int defaultValue,
 int increment)

Description copied from class: EnumIntMap

Returns the key's current value and increments the stored value. If the key is not in the map, defaultValue + increment is put into the map and defaultValue is returned.

Overrides:

getAndIncrement in class EnumIntMap

alter

public boolean alter(Enum<?> before,
 Enum<?> after)

Changes the key before to after without changing its position in the order or its value. Returns true if after has been added to the EnumIntOrderedMap and before has been removed; returns false if after is already present or before is not present. If you are iterating over an EnumIntOrderedMap and have an index, you should prefer alterAt(int, Enum), which doesn't need to search for an index like this does and so can be faster.

Parameters:

before - a key that must be present for this to succeed

after - a key that must not be in this map for this to succeed

Returns:

true if before was removed and after was added, false otherwise

alterAt

public boolean alterAt(int index,
 Enum<?> after)

Changes the key at the given index in the order to after, without changing the ordering of other entries or any values. If after is already present, this returns false; it will also return false if index is invalid for the size of this map. Otherwise, it returns true. Unlike alter(Enum, Enum), this operates in constant time.

Parameters:

index - the index in the order of the key to change; must be non-negative and less than EnumIntMap.size()

after - the key that will replace the contents at index; this key must not be present for this to succeed

Returns:

true if after successfully replaced the key at index, false otherwise

setAt

public int setAt(int index,
 int v)

Changes the value at a specified index in the iteration order to v, without changing keys at all. If index isn't currently a valid index in the iteration order, this returns null. Otherwise, it returns the value that was previously held at index, which may also be null.

Parameters:

v - the new int value to assign

index - the index in the iteration order to set v at

Returns:

the previous value held at index in the iteration order, which may be null if the value was null or if index was invalid

getAt

public int getAt(int index)

Gets the int value at the given index in the insertion order. The index should be between 0 (inclusive) and EnumIntMap.size() (exclusive).

Parameters:

index - an index in the insertion order, between 0 (inclusive) and EnumIntMap.size() (exclusive)

Returns:

the value at the given index

keyAt

public Enum<?> keyAt(int index)

Gets the K key at the given index in the insertion order. The index should be between 0 (inclusive) and EnumIntMap.size() (exclusive).

Parameters:

index - an index in the insertion order, between 0 (inclusive) and EnumIntMap.size() (exclusive)

Returns:

the key at the given index

clear

public void clear()

Description copied from class: EnumIntMap

Removes all the elements from this map. The map will be empty after this call returns. This does not change the universe of possible Enum items this can hold.

Overrides:

clear in class EnumIntMap

clearToUniverse

public void clearToUniverse(Enum<?>[] universe)

Description copied from class: EnumIntMap

Removes all the elements from this map and can reset the universe of possible Enum items this can hold. The map will be empty after this call returns. This changes the universe of possible Enum items this can hold to match universe. If universe is null, this resets this map to the state it would have after EnumIntMap() was called. If the table this would need is the same size as or smaller than the current table (such as if universe is the same as the universe here), this will not allocate, but will still clear any items this holds and will set the universe to the given one. Otherwise, this allocates and uses a new table of a larger size, with nothing in it, and uses the given universe. This always uses universe directly, without copying.
This can be useful to allow an EnumIntMap that was created with EnumIntMap() to share a universe with other EnumIntMaps.

Overrides:

clearToUniverse in class EnumIntMap

Parameters:

universe - the universe of possible Enum items this can hold; almost always produced by values() on an Enum

clearToUniverse

public void clearToUniverse(Class<? extends Enum<?>> universe)

Description copied from class: EnumIntMap

Removes all the elements from this map and can reset the universe of possible Enum items this can hold. The map will be empty after this call returns. This changes the universe of possible Enum items this can hold to match the Enum constants in universe. If universe is null, this resets this map to the state it would have after EnumIntMap() was called. If the table this would need is the same size as or smaller than the current table (such as if universe is the same as the universe here), this will not allocate, but will still clear any items this holds and will set the universe to the given one. Otherwise, this allocates and uses a new table of a larger size, with nothing in it, and uses the given universe. This calls Class.getEnumConstants() if universe is non-null, which allocates a new array.
You may want to prefer calling EnumIntMap.clearToUniverse(Enum[]) (the overload that takes an array), because it can be used to share one universe array between many EnumIntMap instances. This overload, given a Class, has to call Class.getEnumConstants() and thus allocate a new array each time this is called.

Overrides:

clearToUniverse in class EnumIntMap

Parameters:

universe - the Class of an Enum type that stores the universe of possible Enum items this can hold

order

public ObjectList<Enum<?>> order()

Gets the ObjectList of keys in the order this class will iterate through them. Returns a direct reference to the same ObjectList this uses, so changes to the returned list will also change the iteration order here.

Specified by:

order in interface Ordered<Enum<?>>

Returns:

the ObjectList of keys, in iteration order (usually insertion-order), that this uses

sort

public void sort()

Sorts this EnumIntOrderedMap in-place by the keys' natural ordering.

sort

public void sort(Comparator<? super Enum<?>> comp)

Sorts this EnumIntOrderedMap in-place by the given Comparator used on the keys. If comp is null, then this will sort by the natural ordering of the keys.

Specified by:

sort in interface Ordered<Enum<?>>

Parameters:

comp - a Comparator that can compare two Enum keys, or null to use the keys' natural ordering

sortByValue

public void sortByValue(IntComparator comp)

Sorts this EnumIntOrderedMap in-place by the given IntComparator used on the values. comp must not be null, and must be able to compare int values. You can use IntComparators.NATURAL_COMPARATOR to do what sort() does (just sorting values in this case instead of keys); there is also a reversed comparator available, IntComparators.OPPOSITE_COMPARATOR.

Parameters:

comp - a non-null IntComparator

keySet

public EnumIntMap.Keys keySet()

Returns a Set view of the keys contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation), the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll, and clear operations. It does not support the add or addAll operations.

Note that the same Collection instance is returned each time this method is called. Use the OrderedMapKeys(EnumIntOrderedMap) constructor for nested or multithreaded iteration.

Overrides:

keySet in class EnumIntMap

Returns:

a set view of the keys contained in this map

values

public EnumIntMap.Values values()

Returns a PrimitiveCollection for the values in the map. Remove is supported by the PrimitiveCollection's iterator.

Note that the same PrimitiveCollection.OfInt instance is returned each time this method is called. Use the OrderedMapValues(EnumIntOrderedMap) constructor for nested or multithreaded iteration.

Overrides:

values in class EnumIntMap

Returns:

a PrimitiveCollection.OfInt of the int values

entrySet

public EnumIntMap.Entries entrySet()

Returns a Set of Map.Entry, containing the entries in the map. Remove is supported by the Set's iterator.

Note that the same iterator instance is returned each time this method is called. Use the OrderedMapEntries(EnumIntOrderedMap) constructor for nested or multithreaded iteration.

Overrides:

entrySet in class EnumIntMap

Returns:

a Set of Map.Entry key-value pairs

iterator

public EnumIntMap.EntryIterator iterator()

Reuses the iterator of the reused EnumIntMap.Entries produced by entrySet(); does not permit nested iteration. Iterate over OrderedMapEntries(EnumIntOrderedMap) if you need nested or multithreaded iteration. You can remove an Entry from this EnumIntOrderedMap using this Iterator.

Specified by:

iterator in interface Iterable<EnumIntMap.Entry>

Overrides:

iterator in class EnumIntMap

Returns:

an Iterator over key-value pairs as EnumIntMap.Entry values

appendTo

public StringBuilder appendTo(StringBuilder sb,
 String entrySeparator,
 String keyValueSeparator,
 boolean braces,
 Appender<Enum<?>> keyAppender,
 IntAppender valueAppender)

Appends to a StringBuilder from the contents of this EnumIntOrderedMap, but uses the given Appender and IntAppender to convert each key and each value to a customizable representation and append them to a StringBuilder. These functions are often method references to methods in Base, such as Base.appendUnsigned(CharSequence, int). To use the default toString representation, you can use Appender::append as an appender, or to use the readable Enum Enum.name(), use Appender.ENUM_NAME_APPENDER. Use IntAppender.DEFAULT or IntAppender.READABLE for human-readable or source-code-readable results, respectively.

Overrides:

appendTo in class EnumIntMap

Parameters:

sb - a StringBuilder that this can append to

entrySeparator - how to separate entries, such as ", "

keyValueSeparator - how to separate each key from its value, such as "=" or ":"

braces - true to wrap the output in curly braces, or false to omit them

keyAppender - a function that takes a StringBuilder and a K, and returns the modified StringBuilder

valueAppender - a function that takes a StringBuilder and a int, and returns the modified StringBuilder

Returns:

sb, with the appended keys and values of this map

with

public static EnumIntOrderedMap with()

Constructs an empty map. This is usually less useful than just using the constructor, but can be handy in some code-generation scenarios when you don't know how many arguments you will have.

Returns:

a new map containing nothing

with

public static EnumIntOrderedMap with(Enum<?> key0,
 Number value0)

Constructs a single-entry map given one key and one value. This is mostly useful as an optimization for with(Enum, Number, Object...) when there's no "rest" of the keys or values. Like the more-argument with(), this will convert its Number value to a primitive int, regardless of which Number type was used.

Parameters:

key0 - the first and only Enum key

value0 - the first and only value; will be converted to primitive int

Returns:

a new map containing just the entry mapping key0 to value0

with

public static EnumIntOrderedMap with(Enum<?> key0,
 Number value0,
 Enum<?> key1,
 Number value1)

Constructs a map given alternating keys and values. This is mostly useful as an optimization for with(Enum, Number, Object...) when there's no "rest" of the keys or values. Like the more-argument with(), this will convert its Number values to primitive ints, regardless of which Number type was used.

Parameters:

key0 - an Enum key

value0 - a Number for a value; will be converted to primitive int

key1 - an Enum key

value1 - a Number for a value; will be converted to primitive int

Returns:

a new map containing the given key-value pairs

with

public static EnumIntOrderedMap with(Enum<?> key0,
 Number value0,
 Enum<?> key1,
 Number value1,
 Enum<?> key2,
 Number value2)

Constructs a map given alternating keys and values. This is mostly useful as an optimization for with(Enum, Number, Object...) when there's no "rest" of the keys or values. Like the more-argument with(), this will convert its Number values to primitive ints, regardless of which Number type was used.

Parameters:

key0 - an Enum key

value0 - a Number for a value; will be converted to primitive int

key1 - an Enum key

value1 - a Number for a value; will be converted to primitive int

key2 - an Enum key

value2 - a Number for a value; will be converted to primitive int

Returns:

a new map containing the given key-value pairs

with

public static EnumIntOrderedMap with(Enum<?> key0,
 Number value0,
 Enum<?> key1,
 Number value1,
 Enum<?> key2,
 Number value2,
 Enum<?> key3,
 Number value3)

Constructs a map given alternating keys and values. This is mostly useful as an optimization for with(Enum, Number, Object...) when there's no "rest" of the keys or values. Like the more-argument with(), this will convert its Number values to primitive ints, regardless of which Number type was used.

Parameters:

key0 - an Enum key

value0 - a Number for a value; will be converted to primitive int

key1 - an Enum key

value1 - a Number for a value; will be converted to primitive int

key2 - an Enum key

value2 - a Number for a value; will be converted to primitive int

key3 - an Enum key

value3 - a Number for a value; will be converted to primitive int

Returns:

a new map containing the given key-value pairs

with

public static EnumIntOrderedMap with(Enum<?> key0,
 Number value0,
 Object... rest)

Constructs a map given alternating keys and values. This can be useful in some code-generation scenarios, or when you want to make a map conveniently by-hand and have it populated at the start. You can also use EnumIntOrderedMap(Enum[], int[]), which takes all keys and then all values. This needs all keys to be Enum constants. All values must be some type of boxed Number, such as Integer or Double, and will be converted to primitive ints. Any keys that don't have Enum as their type or values that aren't Numbers have that entry skipped.

Parameters:

key0 - the first Enum key

value0 - the first value; will be converted to primitive int

rest - an array or varargs of alternating Enum, Number, Enum, Number... elements

Returns:

a new map containing the given keys and values

parse

public static EnumIntOrderedMap parse(String str,
 String entrySeparator,
 String keyValueSeparator,
 PartialParser<Enum<?>> keyParser)

Creates a new map by parsing all of str with the given PartialParser for keys, with entries separated by entrySeparator, such as ", " and the keys separated from values by keyValueSeparator, such as "=".
The keyParser is often produced by PartialParser.enumParser(ObjToObjFunction).

Parameters:

str - a String containing parseable text

entrySeparator - the String separating every key-value pair

keyValueSeparator - the String separating every key from its corresponding value

keyParser - a PartialParser that returns an Enum key from a section of str

parse

public static EnumIntOrderedMap parse(String str,
 String entrySeparator,
 String keyValueSeparator,
 PartialParser<Enum<?>> keyParser,
 boolean brackets)

Creates a new map by parsing all of str (or if brackets is true, all but the first and last chars) with the given PartialParser for keys, with entries separated by entrySeparator, such as ", " and the keys separated from values by keyValueSeparator, such as "=".
The keyParser is often produced by PartialParser.enumParser(ObjToObjFunction).

Parameters:

str - a String containing parseable text

entrySeparator - the String separating every key-value pair

keyValueSeparator - the String separating every key from its corresponding value

keyParser - a PartialParser that returns an Enum key from a section of str

brackets - if true, the first and last chars in str will be ignored

parse

public static EnumIntOrderedMap parse(String str,
 String entrySeparator,
 String keyValueSeparator,
 PartialParser<Enum<?>> keyParser,
 int offset,
 int length)

Creates a new map by parsing the given subrange of str with the given PartialParser for keys, with entries separated by entrySeparator, such as ", " and the keys separated from values by keyValueSeparator, such as "=".
The keyParser is often produced by PartialParser.enumParser(ObjToObjFunction).

Parameters:

str - a String containing parseable text

entrySeparator - the String separating every key-value pair

keyValueSeparator - the String separating every key from its corresponding value

keyParser - a PartialParser that returns an Enum key from a section of str

offset - the first position to read parseable text from in str

length - how many chars to read; -1 is treated as maximum length

withPrimitive

public static EnumIntOrderedMap withPrimitive()

Constructs an empty map. This is usually less useful than just using the constructor, but can be handy in some code-generation scenarios when you don't know how many arguments you will have.

Returns:

a new map containing nothing

withPrimitive

public static EnumIntOrderedMap withPrimitive(Enum<?> key0,
 int value0)

Constructs a single-entry map given one key and one value. This is mostly useful as an optimization for with(Enum, Number, Object...) when there's no "rest" of the keys or values. Unlike with(), this takes unboxed int as its value type, and will not box it.

Parameters:

key0 - an Enum for a key

value0 - a int for a value

Returns:

a new map containing just the entry mapping key0 to value0

withPrimitive

public static EnumIntOrderedMap withPrimitive(Enum<?> key0,
 int value0,
 Enum<?> key1,
 int value1)

Constructs a map given alternating keys and values. This is mostly useful as an optimization for with(Enum, Number, Object...) when there's no "rest" of the keys or values. Unlike with(), this takes unboxed int as its value type, and will not box it.

Parameters:

key0 - an Enum key

value0 - a int for a value

key1 - an Enum key

value1 - a int for a value

Returns:

a new map containing the given key-value pairs

withPrimitive

public static EnumIntOrderedMap withPrimitive(Enum<?> key0,
 int value0,
 Enum<?> key1,
 int value1,
 Enum<?> key2,
 int value2)

Constructs a map given alternating keys and values. This is mostly useful as an optimization for with(Enum, Number, Object...) when there's no "rest" of the keys or values. Unlike with(), this takes unboxed int as its value type, and will not box it.

Parameters:

key0 - an Enum key

value0 - a int for a value

key1 - an Enum key

value1 - a int for a value

key2 - an Enum key

value2 - a int for a value

Returns:

a new map containing the given key-value pairs

withPrimitive

public static EnumIntOrderedMap withPrimitive(Enum<?> key0,
 int value0,
 Enum<?> key1,
 int value1,
 Enum<?> key2,
 int value2,
 Enum<?> key3,
 int value3)

Constructs a map given alternating keys and values. This is mostly useful as an optimization for with(Enum, Number, Object...) when there's no "rest" of the keys or values. Unlike with(), this takes unboxed int as its value type, and will not box it.

Parameters:

key0 - an Enum key

value0 - a int for a value

key1 - an Enum key

value1 - a int for a value

key2 - an Enum key

value2 - a int for a value

key3 - an Enum key

value3 - a int for a value

Returns:

a new map containing the given key-value pairs

of

public static EnumIntOrderedMap of()

Constructs an empty map. This is usually less useful than just using the constructor, but can be handy in some code-generation scenarios when you don't know how many arguments you will have. This is an alias for with().

Returns:

a new map containing nothing

of

public static EnumIntOrderedMap of(Enum<?> key0,
 Number value0,
 Object... rest)

Constructs a map given alternating keys and values. This can be useful in some code-generation scenarios, or when you want to make a map conveniently by-hand and have it populated at the start. You can also use EnumIntOrderedMap(Enum[], int[]), which takes all keys and then all values. This needs all keys to be Enum constants. All values must be some type of boxed Number, such as Integer or Double, and will be converted to primitive ints. Any keys that don't have Enum as their type or values that aren't Numbers have that entry skipped. This is an alias for with(Enum, Number, Object...).

Parameters:

key0 - the first Enum key

value0 - the first value; will be converted to primitive int

rest - an array or varargs of alternating Enum, Number, Enum, Number... elements

Returns:

a new map containing the given keys and values