Package com.github.tommyettinger.ds

Class IntObjectMap<V>

java.lang.Object
com.github.tommyettinger.ds.IntObjectMap<V>
All Implemented Interfaces:
Iterable<IntObjectMap.Entry<V>>
Direct Known Subclasses:
IntObjectOrderedMap
public class IntObjectMap<V> extends Object implements Iterable<IntObjectMap.Entry<V>>
An unordered map where the keys are unboxed ints and the values are objects. Null keys are not allowed. No allocation is done except when growing the table size.

This class performs fast contains and remove (typically O(1), worst case O(n) but that is rare in practice). Add may be slightly slower, depending on hash collisions. Hashcodes are rehashed to reduce collisions and the need to resize. Load factors greater than 0.91 greatly increase the chances to resize to the next higher POT size.

Unordered sets and maps are not designed to provide especially fast iteration. Iteration is faster with Ordered types like ObjectOrderedSet and ObjectObjectOrderedMap.

You can customize most behavior of this map by extending it. place(int) can be overridden to change how hashCodes are calculated (which can be useful for types like StringBuilder that don't implement hashCode()), and locateKey(int) can be overridden to change how equality is calculated.

This implementation uses linear probing with the backward shift algorithm for removal. It tries different hashes from a simple family, with the hash changing on resize. Linear probing continues to work even when all hashCodes collide, just more slowly.

  • Field Details

    • size

      protected int size

    • keyTable

      protected int[] keyTable

    • valueTable

      protected V[] valueTable

    • hasZeroValue

      protected boolean hasZeroValue

    • zeroValue

      protected V zeroValue

    • loadFactor

      protected float loadFactor
      Between 0f (exclusive) and 1f (inclusive, if you're careful), this determines how full the backing tables can get before this increases their size. Larger values use less memory but make the data structure slower.

    • threshold

      protected int threshold
      Precalculated value of (int)(keyTable.length * loadFactor), used to determine when to resize.

    • shift

      protected int shift
      Used by place(int) to bit shift the upper bits of an int into a usable range (>= 0 and <= mask). The shift can be negative, which is convenient to match the number of bits in mask: if mask is a 7-bit number, a shift of -7 shifts the upper 7 bits into the lowest 7 positions. This class sets the shift > 32 and < 64, which when used with an int will still move the upper bits of an int to the lower bits due to Java's implicit modulus on shifts.

      mask can also be used to mask the low bits of a number, which may be faster for some hashcodes, if place(int) is overridden.

    • mask

      protected int mask
      A bitmask used to confine hashcodes to the size of the table. Must be all 1 bits in its low positions, ie a power of two minus 1. If place(int) is overridden, this can be used instead of shift to isolate usable bits of a hash.

    • hashMultiplier

      protected int hashMultiplier
      Used by place(int) to mix hashCode() results. Changes on every call to resize(int) by default. This should always change when shift changes, meaning, when the backing table resizes. This only needs to be serialized if the full key and value tables are serialized, or if the iteration order should be the same before and after serialization. Iteration order is better handled by using IntObjectOrderedMap.

    • entries1

      protected transient IntObjectMap.Entries<V> entries1

    • entries2

      protected transient IntObjectMap.Entries<V> entries2

    • values1

      protected transient IntObjectMap.Values<V> values1

    • values2

      protected transient IntObjectMap.Values<V> values2

    • keys1

      protected transient IntObjectMap.Keys<V> keys1

    • keys2

      protected transient IntObjectMap.Keys<V> keys2

    • defaultValue

      public V defaultValue

  • Constructor Details

    • IntObjectMap

      public IntObjectMap()
      Creates a new map with an initial capacity of Utilities.getDefaultTableCapacity() and a load factor of Utilities.getDefaultLoadFactor().

    • IntObjectMap

      public IntObjectMap(int initialCapacity)
      Creates a new map with the given starting capacity and a load factor of Utilities.getDefaultLoadFactor().
      Parameters:
      initialCapacity - If not a power of two, it is increased to the next nearest power of two.

    • IntObjectMap

      public IntObjectMap(int initialCapacity, float loadFactor)
      Creates a new map with the specified initial capacity and load factor. This map will hold initialCapacity items before growing the backing table.
      Parameters:
      initialCapacity - If not a power of two, it is increased to the next nearest power of two.
      loadFactor - what fraction of the capacity can be filled before this has to resize; 0 < loadFactor <= 1

    • IntObjectMap

      public IntObjectMap(IntObjectMap<? extends V> map)
      Creates a new map identical to the specified map. This performs a shallow copy, so any references to values (as well as the default value) are shared with the old map.
      Parameters:
      map - the map to copy

    • IntObjectMap

      public IntObjectMap(int[] keys, V[] values)
      Given two side-by-side arrays, one of keys, one of 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 keys
      values - an array of values

    • IntObjectMap

      public IntObjectMap(PrimitiveCollection.OfInt keys, Collection<? extends V> values)
      Given two side-by-side collections, one of keys, one of 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 PrimitiveCollection of keys
      values - a PrimitiveCollection of values

  • Method Details

    • putAll

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

    • place

      protected int place(int item)
      Returns an index >= 0 and <= mask for the specified item.
      Parameters:
      item - any int; it is usually mixed or masked here
      Returns:
      an index between 0 and mask (both inclusive)

    • locateKey

      protected int locateKey(int key)
      Returns the index of the key if already present, else ~index for the next empty index. While this can be overridden to compare for equality differently than == between ints, that isn't recommended because this has to treat zero keys differently, and it finds those with ==.

    • put

      public V put(int key, V value)
      Returns the old value associated with the specified key, or this map's defaultValue if there was no prior value.

    • putOrDefault

      public V putOrDefault(int key, V value, V defaultValue)
      Returns the old value associated with the specified key, or the given defaultValue if there was no prior value.

    • putAll

      public void putAll(IntObjectMap<? 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.
      Parameters:
      map - a map with compatible key and value types; will not be modified

    • putAll

      public void putAll(int[] 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().
      Parameters:
      keys - an array of keys
      values - an array of values

    • putAll

      public void putAll(int[] 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().
      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(int[] 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().
      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

    • putResize

      protected void putResize(int key, V value)
      Skips checks for existing keys, doesn't increment size.

    • get

      public V get(int key)
      Returns the value for the specified key, or defaultValue if the key is not in the map.
      Parameters:
      key - any int

    • getOrDefault

      public V getOrDefault(int key, V defaultValue)
      Returns the value for the specified key, or the default value if the key is not in the map.

    • remove

      public V remove(int key)

    • 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.
      Returns:
      the number of key-value mappings in this map

    • isEmpty

      public boolean isEmpty()
      Returns true if the map is empty.

    • getDefaultValue

      public V getDefaultValue()
      Gets the default value, a V which is returned by get(int) 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(int) if the key is not found. If not changed, the default value is null. Note that getOrDefault(int, 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

    • shrink

      public void shrink(int maximumCapacity)
      Reduces the size of the backing arrays to be the specified capacity / loadFactor, or less. If the capacity is already less, nothing is done. If the map contains more items than the specified capacity, the next highest power of two capacity is used instead.

    • clear

      public void clear(int maximumCapacity)
      Clears the map and reduces the size of the backing arrays to be the specified capacity / loadFactor, if they are larger.

    • clear

      public void clear()

    • containsValue

      public boolean containsValue(Object value)
      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.

    • containsKey

      public boolean containsKey(int key)

    • findKey

      public int findKey(V value, int defaultKey)
      Returns a key that maps to the specified value, or defaultKey if value is not in the map. Note, this traverses the entire map and compares every value, which may be an expensive operation.
      Parameters:
      value - the value to search for
      defaultKey - the key to return when value cannot be found
      Returns:
      a key that maps to value, if present, or defaultKey if value cannot be found

    • ensureCapacity

      public void ensureCapacity(int additionalCapacity)
      Increases the size of the backing array to accommodate the specified number of additional items / loadFactor. Useful before adding many items to avoid multiple backing array resizes.

    • resize

      protected void resize(int newSize)

    • getHashMultiplier

      public int getHashMultiplier()
      Gets the current hashMultiplier, used in place(int) to mix hash codes. If setHashMultiplier(int) is never called, the hashMultiplier will always be drawn from Utilities.GOOD_MULTIPLIERS, with the index equal to 64 - shift.
      Returns:
      the current hashMultiplier

    • setHashMultiplier

      public void setHashMultiplier(int hashMultiplier)
      Sets the hashMultiplier to the given int, which will be made odd if even and always negative (by OR-ing with 0x80000001). This can be any negative, odd int, but should almost always be drawn from Utilities.GOOD_MULTIPLIERS or something like it.
      Parameters:
      hashMultiplier - any int; will be made odd if even.

    • getTableSize

      public int getTableSize()
      Gets the length of the internal array used to store all keys, as well as empty space awaiting more items to be entered. This length is equal to the length of the array used to store all values, and empty space for values, here. This is also called the capacity.
      Returns:
      the length of the internal array that holds all keys

    • getLoadFactor

      public float getLoadFactor()

    • setLoadFactor

      public void setLoadFactor(float loadFactor)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • 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, IntAppender keyAppender, Appender<V> valueAppender)
      Makes a String from the contents of this IntObjectMap, but uses the given IntAppender and Appender to convert each key and each value to a customizable representation and append them to a temporary StringBuilder. These functions are often method references to methods in Base, such as Base.appendReadable(CharSequence, int) and Base.appendUnsigned(CharSequence, int). To use the default String representation, you can use IntAppender.DEFAULT as a keyAppender or Appender::append as a valueAppender.
      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 int, 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, IntAppender keyAppender, Appender<V> valueAppender)
      Appends to a StringBuilder from the contents of this IntFloatMap, but uses the given IntAppender and Appender 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.appendReadable(CharSequence, int) and Base.appendUnsigned(CharSequence, int). To use the default String representation, you can use IntAppender.DEFAULT as a keyAppender or Appender::append as a valueAppender.
      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 int, 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

    • forEach

      public void forEach(com.github.tommyettinger.function.IntObjBiConsumer<? super V> action)
      Performs the given action for each entry in this map until all entries have been processed or the action throws an exception. Unless otherwise specified by the implementing class, actions are performed in the order of entry set iteration (if an iteration order is specified.) Exceptions thrown by the action are relayed to the caller.
      Parameters:
      action - The action to be performed for each entry

    • replaceAll

      public void replaceAll(com.github.tommyettinger.function.IntObjToObjBiFunction<? super V,? extends V> function)
      Replaces each entry's value with the result of invoking the given function on that entry until all entries have been processed or the function throws an exception. Exceptions thrown by the function are relayed to the caller.
      Parameters:
      function - the function to apply to each entry

    • 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

    • iterator

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

    • keySet

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

      Returns:
      a set view of the keys contained in this map

    • values

      public IntObjectMap.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 IntObjectMap.Values constructor for nested or multithreaded iteration.
      Returns:
      a Collection containing V values

    • entrySet

      public IntObjectMap.Entries<V> entrySet()
      Returns a Set of 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 IntObjectMap.Entries constructor for nested or multithreaded iteration.
      Returns:
      a Set of IntObjectMap.Entry key-value pairs

    • putIfAbsent

      public V putIfAbsent(int key, V value)

    • replace

      public boolean replace(int key, V oldValue, V newValue)

    • replace

      public V replace(int key, V value)

    • computeIfAbsent

      public V computeIfAbsent(int key, com.github.tommyettinger.function.IntToObjFunction<? extends V> mappingFunction)

    • remove

      public boolean remove(int key, Object value)

    • merge

      public V merge(int key, V value, com.github.tommyettinger.function.ObjObjToObjBiFunction<? super V,? super V,? extends V> remappingFunction)

    • combine

      public V combine(int 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(IntObjectMap<? extends V> other, com.github.tommyettinger.function.ObjObjToObjBiFunction<? super V,? super V,? extends V> remappingFunction)
      Simply calls combine(int, 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

    • with

      public static <V> IntObjectMap<V> with()
      Constructs an empty map given the key type as a generic type argument. 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> IntObjectMap<V> with(Number key0, V value0)
      Constructs a single-entry map given one key and one value. This is mostly useful as an optimization for with(Number, Object, Object...) when there's no "rest" of the keys or values. Like the more-argument with(), this will convert its V value to a primitive float, regardless of which Number type was used.
      Type Parameters:
      V - the type of value0
      Parameters:
      key0 - the first and only key; will be converted to primitive int
      value0 - the first and only value
      Returns:
      a new map containing just the entry mapping key0 to value0

    • with

      public static <V> IntObjectMap<V> with(Number key0, V value0, Number key1, V value1)
      Constructs a map given alternating keys and values. This is mostly useful as an optimization for with(Number, Object, Object...) when there's no "rest" of the keys or values. Like the more-argument with(), this will convert its V values to primitive floats, regardless of which Number type was used.
      Type Parameters:
      V - the type of values
      Parameters:
      key0 - a Number key; will be converted to primitive int
      value0 - a V value
      key1 - a Number key; will be converted to primitive int
      value1 - a V value
      Returns:
      a new map containing the given key-value pairs

    • with

      public static <V> IntObjectMap<V> with(Number key0, V value0, Number key1, V value1, Number key2, V value2)
      Constructs a map given alternating keys and values. This is mostly useful as an optimization for with(Number, Object, Object...) when there's no "rest" of the keys or values. Like the more-argument with(), this will convert its V values to primitive floats, regardless of which Number type was used.
      Type Parameters:
      V - the type of values
      Parameters:
      key0 - a Number key; will be converted to primitive int
      value0 - a V value
      key1 - a Number key; will be converted to primitive int
      value1 - a V value
      key2 - a Number key; will be converted to primitive int
      value2 - a V value
      Returns:
      a new map containing the given key-value pairs

    • with

      public static <V> IntObjectMap<V> with(Number key0, V value0, Number key1, V value1, Number key2, V value2, Number key3, V value3)
      Constructs a map given alternating keys and values. This is mostly useful as an optimization for with(Number, Object, Object...) when there's no "rest" of the keys or values. Like the more-argument with(), this will convert its V values to primitive floats, regardless of which Number type was used.
      Type Parameters:
      V - the type of values
      Parameters:
      key0 - a Number key; will be converted to primitive int
      value0 - a V value
      key1 - a Number key; will be converted to primitive int
      value1 - a V value
      key2 - a Number key; will be converted to primitive int
      value2 - a V value
      key3 - a Number key; will be converted to primitive int
      value3 - a V value
      Returns:
      a new map containing the given key-value pairs

    • with

      public static <V> IntObjectMap<V> with(Number 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 IntObjectMap(int[], Object[]), which takes all keys and then all values. This needs all keys to have the same type, because it gets a generic type from the first key parameter. All keys must be some type of boxed Number, such as Integer or Double, and will be converted to primitive ints. Any values that don't have V as their type or keys that aren't Numbers have that entry skipped.
      Type Parameters:
      V - the type of values, inferred from value0
      Parameters:
      key0 - the first key; will be converted to primitive int
      value0 - the first value; will be used to determine the type of all values
      rest - an array or varargs of alternating Number, V, Number, 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. All keys must be some type of boxed Number, such as Integer or Double, and will be converted to primitive ints. Any keys that aren't Numbers 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 Number 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 Number, V, Number, V... elements

    • putLegible

      public void putLegible(String str, 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). Each item can vary significantly in length, and should use Base.BASE10 digits, which should be human-readable. 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 BASE10 chars
      valueParser - a PartialParser that returns a V value from a section of str

    • putLegible

      public void putLegible(String str, String entrySeparator, 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). Each item can vary significantly in length, and should use Base.BASE10 digits, which should be human-readable. 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 BASE10 chars
      entrySeparator - the String separating every key-value pair
      valueParser - a PartialParser that returns a V value from a section of str

    • putLegible

      public void putLegible(String str, String entrySeparator, String keyValueSeparator, PartialParser<V> valueParser)
      Adds items to this map drawn from the result of toString(String) or appendTo(StringBuilder, String, String, boolean, IntAppender, Appender). Each key can vary significantly in length, and should use Base.BASE10 digits, which should be human-readable. 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 BASE10 chars
      entrySeparator - the String separating every key-value pair
      keyValueSeparator - the String separating every key from its corresponding value
      valueParser - a PartialParser that returns a V value from a section of str

    • putLegible

      public void putLegible(String str, String entrySeparator, String keyValueSeparator, 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, IntAppender, Appender). Each key can vary significantly in length, and should use Base.BASE10 digits, which should be human-readable. 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 BASE10 chars
      entrySeparator - the String separating every key-value pair
      keyValueSeparator - the String separating every key from its corresponding value
      valueParser - a PartialParser that returns a V value from a section of str
      offset - the first position to read BASE10 chars from in str
      length - how many chars to read; -1 is treated as maximum length

    • withPrimitive

      public static <V> IntObjectMap<V> withPrimitive()
      Constructs an empty map given the key type as a generic type argument. 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

    • withPrimitive

      public static <V> IntObjectMap<V> withPrimitive(int key0, V value0)
      Constructs a single-entry map given one key and one value. This is mostly useful as an optimization for with(Number, Object, Object...) when there's no "rest" of the keys or values. Unlike with(), this takes unboxed int as its key type, and will not box it.
      Type Parameters:
      V - the type of value0
      Parameters:
      key0 - a int key
      value0 - a V value
      Returns:
      a new map containing just the entry mapping key0 to value0

    • withPrimitive

      public static <V> IntObjectMap<V> withPrimitive(int key0, V value0, int key1, V value1)
      Constructs a map given alternating keys and values. This is mostly useful as an optimization for with(Number, Object, Object...) when there's no "rest" of the keys or values. Unlike with(), this takes unboxed int as its key type, and will not box it.
      Type Parameters:
      V - the type of values
      Parameters:
      key0 - a int key
      value0 - a V value
      key1 - a int key
      value1 - a V value
      Returns:
      a new map containing the given key-value pairs

    • withPrimitive

      public static <V> IntObjectMap<V> withPrimitive(int key0, V value0, int key1, V value1, int key2, V value2)
      Constructs a map given alternating keys and values. This is mostly useful as an optimization for with(Number, Object, Object...) when there's no "rest" of the keys or values. Unlike with(), this takes unboxed int as its key type, and will not box it.
      Type Parameters:
      V - the type of values
      Parameters:
      key0 - a int key
      value0 - a V value
      key1 - a int key
      value1 - a V value
      key2 - a int key
      value2 - a V value
      Returns:
      a new map containing the given key-value pairs

    • withPrimitive

      public static <V> IntObjectMap<V> withPrimitive(int key0, V value0, int key1, V value1, int key2, V value2, int key3, V value3)
      Constructs a map given alternating keys and values. This is mostly useful as an optimization for with(Number, Object, Object...) when there's no "rest" of the keys or values. Unlike with(), this takes unboxed int as its key type, and will not box it.
      Type Parameters:
      V - the type of values
      Parameters:
      key0 - a int key
      value0 - a V value
      key1 - a int key
      value1 - a V value
      key2 - a int key
      value2 - a V value
      key3 - a int key
      value3 - a V value
      Returns:
      a new map containing the given key-value pairs

    • parse

      public static <V> IntObjectMap<V> parse(String str, String entrySeparator, String keyValueSeparator, PartialParser<V> valueParser)
      Creates a new map by parsing all of str with the given PartialParser 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).
      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
      valueParser - a PartialParser that returns a V value from a section of str

    • parse

      public static <V> IntObjectMap<V> parse(String str, String entrySeparator, String keyValueSeparator, 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 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).
      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
      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> IntObjectMap<V> parse(String str, String entrySeparator, String keyValueSeparator, PartialParser<V> valueParser, int offset, int length)
      Creates a new map by parsing the given subrange of str with the given PartialParser 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).
      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
      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