Package com.github.tommyettinger.ds

Class EnumMap<V>

java.lang.Object
com.github.tommyettinger.ds.EnumMap<V>
All Implemented Interfaces:
Iterable<Map.Entry<Enum<?>,V>>, Map<Enum<?>,V>
Direct Known Subclasses:
EnumOrderedMap
public class EnumMap<V> extends Object implements Map<Enum<?>,V>, Iterable<Map.Entry<Enum<?>,V>>
An unordered map where the keys are Enums and values are objects. Null keys are not allowed; null values are permitted. 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 EnumMap 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 EnumMap(Enum[]) (with no values given) creates an empty EnumMap 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 EnumMap. 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, though this expands on that where possible.

  • Field Details

    • size

      protected int size

    • universe

      protected Enum<?>[] universe

    • valueTable

      protected Object[] valueTable

    • entries1

      protected transient EnumMap.Entries<V> entries1

    • entries2

      protected transient EnumMap.Entries<V> entries2

    • values1

      protected transient EnumMap.Values<V> values1

    • values2

      protected transient EnumMap.Values<V> values2

    • keys1

      protected transient EnumMap.Keys keys1

    • keys2

      protected transient EnumMap.Keys keys2

    • defaultValue

      public V defaultValue
      Returned by get(Object) when no value exists for the given key, as well as some other methods to indicate that no value in the Map could be returned. Defaults to null.

  • Constructor Details

    • EnumMap

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

    • EnumMap

      public EnumMap(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 EnumMap instances if you don't modify the shared array. Sharing the same universe helps save some memory if you have (very) many EnumMap instances.
      Parameters:
      universe - almost always, the result of calling values() on an Enum type; used directly, not copied

    • EnumMap

      public EnumMap(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 EnumMap(Enum[]) for convenience. Note that this constructor allocates a new array of Enum constants each time it is called, where if you use EnumMap(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

    • EnumMap

      public EnumMap(EnumMap<? extends V> map)
      Creates a new map identical to the specified EnumMap. This will share a key universe with the given EnumMap, if non-null.
      Parameters:
      map - an EnumMap to copy

    • EnumMap

      public EnumMap(Map<? extends Enum<?>,? extends V> map)
      Creates a new map identical to the specified map.
      Parameters:
      map - a Map to copy; EnumMap or its subclasses will be faster

    • EnumMap

      public EnumMap(Enum<?>[] keys, V[] values)
      Given two side-by-side arrays, one of Enum keys, one of V 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 V values

    • EnumMap

      public EnumMap(Collection<? extends Enum<?>> keys, Collection<? extends V> values)
      Given two side-by-side collections, one of Enum keys, one of V 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 Collection of V values

  • Method Details

    • hold

      protected Object hold(Object o)
      If the given Object is null, this replaces it with a placeholder value (Utilities.neverIdentical); otherwise, it returns the given Object as-is.
      Parameters:
      o - any Object; will be returned as-is unless it is null
      Returns:
      the given Object or Utilities.neverIdentical

    • release

      protected V release(Object o)
      If the given Object is Utilities.neverIdentical, this "releases its hold" on that placeholder value and returns null; otherwise, it returns the given Object (cast to V if non-null).
      Parameters:
      o - any Object, but should be the placeholder Utilities.neverIdentical or a V instance
      Returns:
      the V passed in, or null if it is the placeholder

    • put

      public V put(Enum<?> key, V value)
      Returns the old value associated with the specified key, or this map's defaultValue if there was no prior value. If this EnumMap 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 EnumMap.
      Specified by:
      put in interface Map<Enum<?>,V>
      Parameters:
      key - the Enum key to try to place into this EnumMap
      value - the V value to associate with key
      Returns:
      the previous value associated with key, or getDefaultValue() if the given key was not present

    • putOrDefault

      public V putOrDefault(Enum<?> key, V value, V defaultValue)
      Acts like put(Enum, Object), but uses the specified defaultValue instead of the default value for this EnumMap.
      Parameters:
      key - the Enum key to try to place into this EnumMap
      value - the V value to associate with key
      defaultValue - the V 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(EnumMap<? extends V> 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. If this EnumMap doesn't yet have a key universe, it will now share a key universe with the given map. Even if the given EnumMap is empty, it can still be used to obtain a key universe for this EnumMap (assuming it has a key universe).
      Parameters:
      map - a map with compatible key and value types; will not be modified

    • putAll

      public void putAll(Enum<?>[] keys, V[] values)
      Given two side-by-side arrays, one of keys, one of values, this inserts each pair of key and value into this map with put(). Delegates to putAll(Enum[], int, Object[], int, int).
      Parameters:
      keys - an array of keys
      values - an array of values

    • putAll

      public void putAll(Enum<?>[] keys, V[] values, int length)
      Given two side-by-side arrays, one of keys, one of values, this inserts each pair of key and value into this map with put(). Delegates to putAll(Enum[], int, Object[], int, int).
      Parameters:
      keys - an array of keys
      values - an array of values
      length - how many items from keys and values to insert, at-most

    • putAll

      public void putAll(Enum<?>[] keys, int keyOffset, V[] values, int valueOffset, int length)
      Given two side-by-side arrays, one of keys, one of values, this inserts each pair of key and value into this map with put(Enum, Object).
      Parameters:
      keys - an array of keys
      keyOffset - the first index in keys to insert
      values - an array of values
      valueOffset - the first index in values to insert
      length - how many items from keys and values to insert, at-most

    • putAll

      public void putAll(Collection<? extends Enum<?>> keys, Collection<? extends V> values)
      Given two side-by-side collections, one of Enum keys, one of V values, this inserts each pair of key and value into this map with put().
      Parameters:
      keys - a Collection of Enum keys
      values - a Collection of V values

    • get

      public V get(Object key)
      Returns the value for the specified key, or defaultValue if the key is not in the map. Note that defaultValue is often null, which is also a valid value that can be assigned to a legitimate key. Checking that the result of this method is null does not guarantee that the key is not present.
      Specified by:
      get in interface Map<Enum<?>,V>
      Parameters:
      key - a non-null Object that should almost always be a K (or an instance of a subclass of K)

    • getOrDefault

      public V getOrDefault(Object key, V defaultValue)
      Returns the value for the specified key, or the given default value if the key is not in the map.
      Specified by:
      getOrDefault in interface Map<Enum<?>,V>

    • remove

      public V remove(Object key)
      Specified by:
      remove in interface Map<Enum<?>,V>

    • putAll

      public void putAll(Map<? extends Enum<?>,? extends V> m)
      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(EnumMap) is more specific and can be more efficient by using the internal details of this class.
      Specified by:
      putAll in interface Map<Enum<?>,V>
      Parameters:
      m - 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

    • notEmpty

      public boolean notEmpty()
      Returns true if the map has one or more items.

    • size

      public int size()
      Returns the number of key-value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
      Specified by:
      size in interface Map<Enum<?>,V>
      Returns:
      the number of key-value mappings in this map

    • isEmpty

      public boolean isEmpty()
      Returns true if the map is empty.
      Specified by:
      isEmpty in interface Map<Enum<?>,V>

    • getDefaultValue

      public V getDefaultValue()
      Gets the default value, a V which is returned by get(Object) if the key is not found. If not changed, the default value is null.
      Returns:
      the current default value

    • setDefaultValue

      public void setDefaultValue(V defaultValue)
      Sets the default value, a V which is returned by get(Object) if the key is not found. If not changed, the default value is null. Note that getOrDefault(Object, Object) is also available, which allows specifying a "not-found" value per-call.
      Parameters:
      defaultValue - may be any V object or null; should usually be one that doesn't occur as a typical value

    • clear

      public void clear()
      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.
      Specified by:
      clear in interface Map<Enum<?>,V>

    • clearToUniverse

      public void clearToUniverse(Enum<?>[] universe)
      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 EnumMap() 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 EnumMap that was created with EnumMap() to share a universe with other EnumMaps.
      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)
      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 EnumMap() 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 clearToUniverse(Enum[]) (the overload that takes an array), because it can be used to share one universe array between many EnumMap instances. This overload, given a Class, has to call Class.getEnumConstants() and thus allocate a new array each time this is called.
      Parameters:
      universe - the Class of an Enum type that stores the universe of possible Enum items this can hold

    • getUniverse

      public Enum<?>[] getUniverse()
      Gets the current key universe; this is a technically-mutable array, but should never be modified. To set the universe on an existing EnumMap (with existing contents), you can use clearToUniverse(Enum[]). If an EnumMap has not been initialized, just adding a key will set the key universe to match the given item.
      Returns:
      the current key universe

    • 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. This indiscriminately removes items from the backing array until the requested newSize is reached, or until the full backing array has had its elements removed.
      This tries to remove from the end of the iteration order, but because the iteration order is not guaranteed by an unordered map, this can remove essentially any item(s) from the map if it is larger than newSize.
      Parameters:
      newSize - the target size to try to reach by removing items, if smaller than the current size

    • containsValue

      public boolean containsValue(Object value, boolean identity)
      Returns true if the specified value is in the map. Note this traverses the entire map and compares every value, which may be an expensive operation.
      Parameters:
      identity - If true, uses == to compare the specified value with values in the map. If false, uses equals(Object).

    • containsKey

      public boolean containsKey(Object key)
      Specified by:
      containsKey in interface Map<Enum<?>,V>

    • containsValue

      public boolean containsValue(Object value)
      Returns true if this map maps one or more keys to the specified value. More formally, returns true if and only if this map contains at least one mapping to a value v such that (value==null ? v==null : value.equals(v)). This operation will probably require time linear in the map size for most implementations of the Map interface.
      Specified by:
      containsValue in interface Map<Enum<?>,V>
      Parameters:
      value - value whose presence in this map is to be tested
      Returns:
      true if this map maps one or more keys to the specified value
      Throws:
      ClassCastException - if the value is of an inappropriate type for this map (optional)
      NullPointerException - if the specified value is null and this map does not permit null values (optional)

    • findKey

      public Enum<?> findKey(Object value, boolean identity)
      Returns the key for the specified value, or null if it is not in the map. Note this traverses the entire map and compares every value, which may be an expensive operation.
      Parameters:
      identity - If true, uses == to compare the specified value with values in the map. If false, uses equals(Object).
      Returns:
      the corresponding Enum if the value was found, or null otherwise

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface Map<Enum<?>,V>
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface Map<Enum<?>,V>
      Overrides:
      equals in class Object

    • equalsIdentity

      public boolean equalsIdentity(Object obj)
      Uses == for comparison of each value.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • toString

      public String toString(String entrySeparator)
      Delegates to toString(String, boolean) with the given entrySeparator and without braces. This is different from toString(), which includes braces by default.
      Parameters:
      entrySeparator - how to separate entries, such as ", "
      Returns:
      a new String representing this map

    • toString

      public String toString(String entrySeparator, boolean braces)

    • toString

      public String toString(String entrySeparator, String keyValueSeparator, boolean braces, Appender<Enum<?>> keyAppender, Appender<V> valueAppender)
      Makes a String from the contents of this EnumMap, but uses the given Appender and Appender to convert each key and each value to a customizable representation and append them to a temporary StringBuilder. 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.
      Parameters:
      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 an Enum, and returns the modified StringBuilder
      valueAppender - a function that takes a StringBuilder and a V, and returns the modified StringBuilder
      Returns:
      a new String representing this map

    • appendTo

      public StringBuilder appendTo(StringBuilder sb, String entrySeparator, boolean braces)

    • appendTo

      public StringBuilder appendTo(StringBuilder sb, String entrySeparator, String keyValueSeparator, boolean braces, Appender<Enum<?>> keyAppender, Appender<V> valueAppender)
      Appends to a StringBuilder from the contents of this EnumMap, but uses the given Appender and Appender to convert each key and each value to a customizable representation and append them to a StringBuilder. To use the default String representation, you can use Appender::append as an appender.
      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 an Enum, and returns the modified StringBuilder
      valueAppender - a function that takes a StringBuilder and a V, and returns the modified StringBuilder
      Returns:
      sb, with the appended keys and values of this map

    • replace

      public V replace(Enum<?> key, V value)
      Specified by:
      replace in interface Map<Enum<?>,V>

    • combine

      public V combine(Enum<?> key, V value, com.github.tommyettinger.function.ObjObjToObjBiFunction<? super V,? super V,? extends V> remappingFunction)
      Just like Map's merge() default method, but this doesn't use Java 8 APIs (so it should work on RoboVM), and this won't remove entries if the remappingFunction returns null (in that case, it will call put(key, null)). This also uses a functional interface from Funderby instead of the JDK, for RoboVM support.
      Parameters:
      key - key with which the resulting value is to be associated
      value - the value to be merged with the existing value associated with the key or, if no existing value is associated with the key, to be associated with the key
      remappingFunction - given a V from this and the V value, this should return what V to use
      Returns:
      the value now associated with key

    • combine

      public void combine(Map<? extends Enum<?>,? extends V> other, com.github.tommyettinger.function.ObjObjToObjBiFunction<? super V,? super V,? extends V> remappingFunction)
      Simply calls combine(Enum, Object, ObjObjToObjBiFunction) on this map using every key-value pair in other. If other isn't empty, calling this will probably modify this map, though this depends on the remappingFunction.
      Parameters:
      other - a non-null Map (or subclass) with compatible key and value types
      remappingFunction - given a V value from this and a value from other, this should return what V to use

    • iterator

      public EnumMap.MapIterator<V,Map.Entry<Enum<?>,V>> iterator()
      Reuses the iterator of the reused EnumMap.Entries produced by entrySet(); does not permit nested iteration. Iterate over Entries(EnumMap) if you need nested or multithreaded iteration. You can remove an Entry from this EnumMap using this Iterator.
      Specified by:
      iterator in interface Iterable<V>
      Returns:
      an Iterator over Map.Entry key-value pairs; remove is supported.

    • keySet

      public EnumMap.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 EnumMap.Keys constructor for nested or multithreaded iteration.

      Specified by:
      keySet in interface Map<Enum<?>,V>
      Returns:
      a set view of the keys contained in this map

    • values

      public EnumMap.Values<V> values()
      Returns a Collection of the values in the map. Remove is supported. Note that the same Collection instance is returned each time this method is called. Use the EnumMap.Values constructor for nested or multithreaded iteration.
      Specified by:
      values in interface Map<Enum<?>,V>
      Returns:
      a Collection of V values

    • entrySet

      public EnumMap.Entries<V> 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 EnumMap.Entries constructor for nested or multithreaded iteration.
      Specified by:
      entrySet in interface Map<Enum<?>,V>
      Returns:
      a Set of Map.Entry key-value pairs

    • with

      public static <V> EnumMap<V> with()
      Constructs an empty map given the types as generic type arguments. 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.
      Type Parameters:
      V - the type of values
      Returns:
      a new map containing nothing

    • with

      public static <V> EnumMap<V> with(Enum<?> key0, V value0)
      Constructs a single-entry map given one key and one value. This is mostly useful as an optimization for with(Enum, Object, Object...) when there's no "rest" of the keys or values.
      Type Parameters:
      V - the type of value0
      Parameters:
      key0 - the first and only key
      value0 - the first and only value
      Returns:
      a new map containing just the entry mapping key0 to value0

    • with

      public static <V> EnumMap<V> with(Enum<?> key0, V value0, Enum<?> key1, V value1)
      Constructs a single-entry map given two key-value pairs. This is mostly useful as an optimization for with(Enum, Object, Object...) when there's no "rest" of the keys or values.
      Type Parameters:
      V - the type of value0
      Parameters:
      key0 - an Enum key
      value0 - a V value
      key1 - an Enum key
      value1 - a V value
      Returns:
      a new map containing entries mapping each key to the following value

    • with

      public static <V> EnumMap<V> with(Enum<?> key0, V value0, Enum<?> key1, V value1, Enum<?> key2, V value2)
      Constructs a single-entry map given three key-value pairs. This is mostly useful as an optimization for with(Enum, Object, Object...) when there's no "rest" of the keys or values.
      Type Parameters:
      V - the type of value0
      Parameters:
      key0 - an Enum key
      value0 - a V value
      key1 - an Enum key
      value1 - a V value
      key2 - an Enum key
      value2 - a V value
      Returns:
      a new map containing entries mapping each key to the following value

    • with

      public static <V> EnumMap<V> with(Enum<?> key0, V value0, Enum<?> key1, V value1, Enum<?> key2, V value2, Enum<?> key3, V value3)
      Constructs a single-entry map given four key-value pairs. This is mostly useful as an optimization for with(Enum, Object, Object...) when there's no "rest" of the keys or values.
      Type Parameters:
      V - the type of value0
      Parameters:
      key0 - an Enum key
      value0 - a V value
      key1 - an Enum key
      value1 - a V value
      key2 - an Enum key
      value2 - a V value
      key3 - an Enum key
      value3 - a V value
      Returns:
      a new map containing entries mapping each key to the following value

    • with

      public static <V> EnumMap<V> with(Enum<?> key0, V 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 EnumMap(Enum[], Object[]), which takes all keys and then all values. This needs all keys to have the same type and all values to have the same type, because it gets those types from the first key parameter and first value parameter. Any keys that don't have Enum as their type or values that don't have V as their type have that entry skipped.
      Type Parameters:
      V - the type of values, inferred from value0
      Parameters:
      key0 - the first key (an Enum)
      value0 - the first value; will be used to determine the type of all values
      rest - an array or varargs of alternating Enum, V, Enum, V... elements
      Returns:
      a new map containing the given keys and values

    • putPairs

      public void putPairs(Object... pairs)
      Attempts to put alternating key-value pairs into this map, drawing a key, then a value from pairs, then another key, another value, and so on until another pair cannot be drawn. Any keys that don't have K as their type or values that don't have V as their type have that entry skipped.
      If any item in pairs cannot be cast to the appropriate K or V type for its position in the arguments, that pair is ignored and neither that key nor value is put into the map. If any key is null, that pair is ignored, as well. If pairs is an Object array that is null, the entire call to putPairs() is ignored. If the length of pairs is odd, the last item (which will be unpaired) is ignored.
      Parameters:
      pairs - an array or varargs of alternating K, V, K, V... elements

    • putLegible

      public void putLegible(String str, PartialParser<Enum<?>> keyParser, PartialParser<V> valueParser)
      Adds items to this map drawn from the result of toString(String) or appendTo(StringBuilder, String, boolean). Every key-value pair should be separated by ", ", and every key should be followed by "=" before the value (which toString() does). A PartialParser will be used to parse keys from sections of str, and a different PartialParser to parse values. Usually, keyParser is produced by PartialParser.enumParser(ObjToObjFunction). Any brackets inside the given range of characters will ruin the parsing, so increase offset by 1 and reduce length by 2 if the original String had brackets added to it.
      Parameters:
      str - a String containing parseable text
      keyParser - a PartialParser that returns a Enum<?> key from a section of str, typically produced by PartialParser.enumParser(ObjToObjFunction)
      valueParser - a PartialParser that returns a V value from a section of str

    • putLegible

      public void putLegible(String str, String entrySeparator, PartialParser<Enum<?>> keyParser, PartialParser<V> valueParser)
      Adds items to this map drawn from the result of toString(String) or appendTo(StringBuilder, String, boolean). Every key-value pair should be separated by entrySeparator, and every key should be followed by "=" before the value (which toString(String) does). A PartialParser will be used to parse keys from sections of str, and a different PartialParser to parse values. Usually, keyParser is produced by PartialParser.enumParser(ObjToObjFunction). Any brackets inside the given range of characters will ruin the parsing, so increase offset by 1 and reduce length by 2 if the original String had brackets added to it.
      Parameters:
      str - a String containing parseable text
      entrySeparator - the String separating every key-value pair
      keyParser - a PartialParser that returns a Enum<?> key from a section of str, typically produced by PartialParser.enumParser(ObjToObjFunction)
      valueParser - a PartialParser that returns a V value from a section of str

    • putLegible

      public void putLegible(String str, String entrySeparator, String keyValueSeparator, PartialParser<Enum<?>> keyParser, PartialParser<V> valueParser)
      Adds items to this map drawn from the result of toString(String) or appendTo(StringBuilder, String, String, boolean, Appender, Appender). A PartialParser will be used to parse keys from sections of str, and a different PartialParser to parse values. Usually, keyParser is produced by PartialParser.enumParser(ObjToObjFunction). Any brackets inside the given range of characters will ruin the parsing, so increase offset by 1 and reduce length by 2 if the original String had brackets added to it.
      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 a Enum<?> key from a section of str, typically produced by PartialParser.enumParser(ObjToObjFunction)
      valueParser - a PartialParser that returns a V value from a section of str

    • putLegible

      public void putLegible(String str, String entrySeparator, String keyValueSeparator, PartialParser<Enum<?>> keyParser, PartialParser<V> valueParser, int offset, int length)
      Puts key-value pairs into this map drawn from the result of toString(String) or appendTo(StringBuilder, String, String, boolean, Appender, Appender). A PartialParser will be used to parse keys from sections of str, and a different PartialParser to parse values. Usually, keyParser is produced by PartialParser.enumParser(ObjToObjFunction). Any brackets inside the given range of characters will ruin the parsing, so increase offset by 1 and reduce length by 2 if the original String had brackets added to it.
      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 a Enum<?> key from a section of str, typically produced by PartialParser.enumParser(ObjToObjFunction)
      valueParser - a PartialParser that returns a V value 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

    • parse

      public static <V> EnumMap<V> parse(String str, String entrySeparator, String keyValueSeparator, PartialParser<Enum<?>> keyParser, PartialParser<V> valueParser)
      Creates a new map by parsing all of str with the given PartialParser for keys and for values, with entries separated by entrySeparator, such as ", " and the keys separated from values by keyValueSeparator, such as "=".
      Various PartialParser instances are defined as constants, such as PartialParser.DEFAULT_STRING, and others can be created by static methods in PartialParser, such as PartialParser.objectListParser(PartialParser, String, boolean). 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
      valueParser - a PartialParser that returns a V value from a section of str

    • parse

      public static <V> EnumMap<V> parse(String str, String entrySeparator, String keyValueSeparator, PartialParser<Enum<?>> keyParser, PartialParser<V> valueParser, 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 and for values, with entries separated by entrySeparator, such as ", " and the keys separated from values by keyValueSeparator, such as "=".
      Various PartialParser instances are defined as constants, such as PartialParser.DEFAULT_STRING, and others can be created by static methods in PartialParser, such as PartialParser.objectListParser(PartialParser, String, boolean). 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
      valueParser - a PartialParser that returns a V value from a section of str
      brackets - if true, the first and last chars in str will be ignored

    • parse

      public static <V> EnumMap<V> parse(String str, String entrySeparator, String keyValueSeparator, PartialParser<Enum<?>> keyParser, PartialParser<V> valueParser, int offset, int length)
      Creates a new map by parsing the given subrange of str with the given PartialParser for keys and for values, with entries separated by entrySeparator, such as ", " and the keys separated from values by keyValueSeparator, such as "=".
      Various PartialParser instances are defined as constants, such as PartialParser.DEFAULT_STRING, and others can be created by static methods in PartialParser, such as PartialParser.objectListParser(PartialParser, String, boolean). 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
      valueParser - a PartialParser that returns a V value 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

    • of

      public static <V> EnumMap<V> of()
      Constructs an empty map given the types as generic type arguments; an alias for with().
      Type Parameters:
      V - the type of values
      Returns:
      a new map containing nothing

    • of

      public static <V> EnumMap<V> of(Enum<?> key0, V value0)
      Constructs a single-entry map given one key and one value; an alias for with(Enum, Object).
      Type Parameters:
      V - the type of value0
      Parameters:
      key0 - the first and only key
      value0 - the first and only value
      Returns:
      a new map containing just the entry mapping key0 to value0

    • of

      public static <V> EnumMap<V> of(Enum<?> key0, V value0, Object... rest)
      Constructs a map given alternating keys and values; an alias for with(Enum, Object, Object...).
      Type Parameters:
      V - the type of values, inferred from value0
      Parameters:
      key0 - the first key (an Enum)
      value0 - the first value; will be used to determine the type of all values
      rest - an array or varargs of alternating Enum, V, Enum, V... elements
      Returns:
      a new map containing the given keys and values

    • noneOf

      public static <V> EnumMap<V> noneOf(Enum<?>[] universe)
      Constructs an empty map that can store keys from the given universe, using the specified generic type for values. The universe is usually obtained from an Enum type's values() method, and is often shared between Enum-keyed maps and sets.
      Type Parameters:
      V - the type of values
      Parameters:
      universe - a key universe, as an array of Enum constants typically obtained via values()
      Returns:
      a new map containing nothing