Package org.eclipse.collections.impl.map.mutable.primitive

Class CharIntHashMap

java.lang.Object
org.eclipse.collections.impl.primitive.AbstractIntIterable
org.eclipse.collections.impl.map.mutable.primitive.AbstractMutableIntValuesMap
org.eclipse.collections.impl.map.mutable.primitive.CharIntHashMap
All Implemented Interfaces:
Externalizable, Serializable, IntIterable, CharIntMap, IntValuesMap, MutableCharIntMap, MutableIntValuesMap, PrimitiveIterable, MutableCharKeysMap, CharKeysMap
public class CharIntHashMap
extends AbstractMutableIntValuesMap
implements MutableCharIntMap, Externalizable, MutableCharKeysMap
This file was automatically generated from template file primitivePrimitiveHashMap.stg.
Since:
3.0.
See Also:
Serialized Form

  • Constructor Details

  • Method Details

    • newWithKeysValues

      public static CharIntHashMap newWithKeysValues​(char key1, int value1)

    • newWithKeysValues

      public static CharIntHashMap newWithKeysValues​(char key1, int value1, char key2, int value2)

    • newWithKeysValues

      public static CharIntHashMap newWithKeysValues​(char key1, int value1, char key2, int value2, char key3, int value3)

    • newWithKeysValues

      public static CharIntHashMap newWithKeysValues​(char key1, int value1, char key2, int value2, char key3, int value3, char key4, int value4)

    • equals

      public boolean equals​(Object obj)
      Description copied from interface: CharIntMap
      Follows the same general contract as Map.equals(Object).
      Specified by:
      equals in interface CharIntMap
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Description copied from interface: CharIntMap
      Follows the same general contract as Map.hashCode().
      Specified by:
      hashCode in interface CharIntMap
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Description copied from interface: PrimitiveIterable
      Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets. 
       Assert.assertEquals("[]", IntLists.mutable.empty().toString());
 Assert.assertEquals("[1]", IntLists.mutable.with(1).toString());
 Assert.assertEquals("[1, 2, 3]", IntLists.mutable.with(1, 2, 3).toString());
      Specified by:
      toString in interface CharIntMap
      Specified by:
      toString in interface PrimitiveIterable
      Overrides:
      toString in class AbstractIntIterable
      Returns:
      a string representation of this PrimitiveIterable
      See Also:
      AbstractCollection.toString()

    • intIterator

      public MutableIntIterator intIterator()
      Description copied from interface: IntIterable
      Returns a primitive iterator that can be used to iterate over the IntIterable in an imperative style.
      Specified by:
      intIterator in interface IntIterable
      Specified by:
      intIterator in interface MutableIntValuesMap

    • injectInto

      public <V> V injectInto​(V injectedValue, ObjectIntToObjectFunction<? super V,​? extends V> function)
      Specified by:
      injectInto in interface IntIterable

    • clear

      public void clear()
      Description copied from interface: MutableIntValuesMap
      Removes all entries from this map.
      Specified by:
      clear in interface MutableCharKeysMap
      Specified by:
      clear in interface MutableIntValuesMap

    • put

      public void put​(char key, int value)
      Description copied from interface: MutableCharIntMap
      Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.
      Specified by:
      put in interface MutableCharIntMap
      Parameters:
      key - the key
      value - the value to associate with value

    • putAll

      public void putAll​(CharIntMap map)
      Description copied from interface: MutableCharIntMap
      Puts all of the key/value mappings from the specified map into this map. If this map already has a value associated with one of the keys in the map, it will be replaced with the value in map.
      Specified by:
      putAll in interface MutableCharIntMap
      Parameters:
      map - the map to copy into this map

    • updateValues

      public void updateValues​(CharIntToIntFunction function)
      Description copied from interface: MutableCharIntMap
      Updates the values in-place.
      Specified by:
      updateValues in interface MutableCharIntMap
      Parameters:
      function - that takes a key and its value and that returns a new value for this key

    • removeKey

      public void removeKey​(char key)
      Description copied from interface: MutableCharIntMap
      Removes the mapping associated with the key, if one exists, from the map.
      Specified by:
      removeKey in interface MutableCharIntMap
      Specified by:
      removeKey in interface MutableCharKeysMap
      Parameters:
      key - the key to remove
      See Also:
      MutableCharIntMap.remove(char)

    • remove

      public void remove​(char key)
      Description copied from interface: MutableCharIntMap
      Removes the mapping associated with the key, if one exists, from the map.
      Specified by:
      remove in interface MutableCharIntMap
      Parameters:
      key - the key to remove
      See Also:
      MutableCharIntMap.removeKey(char)

    • removeKeyIfAbsent

      public int removeKeyIfAbsent​(char key, int value)
      Description copied from interface: MutableCharIntMap
      Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key. If no mapping existed for the key, the specified default value is returned.
      Specified by:
      removeKeyIfAbsent in interface MutableCharIntMap
      Parameters:
      key - the key to remove
      value - the default value to return if no mapping for the key exists
      Returns:
      the value previously associated with the key, if one existed, or value if not

    • getIfAbsentPut

      public int getIfAbsentPut​(char key, int value)
      Description copied from interface: MutableCharIntMap
      Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
      Specified by:
      getIfAbsentPut in interface MutableCharIntMap
      Parameters:
      key - the key
      value - the value to associate with key if no such mapping exists
      Returns:
      the value associated with key, if one exists, or value if not

    • getIfAbsentPut

      public int getIfAbsentPut​(char key, IntFunction0 function)
      Description copied from interface: MutableCharIntMap
      Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.
      Specified by:
      getIfAbsentPut in interface MutableCharIntMap
      Parameters:
      key - the key
      function - the supplier that provides the value if no mapping exists for key
      Returns:
      the value associated with the key, if one exists, or the result of invoking function if not

    • getIfAbsentPutWith

      public <P> int getIfAbsentPutWith​(char key, IntFunction<? super P> function, P parameter)
      Description copied from interface: MutableCharIntMap
      Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.
      Specified by:
      getIfAbsentPutWith in interface MutableCharIntMap
      Type Parameters:
      P - the type of the value function's parameter
      Parameters:
      key - the key
      function - the function that provides the value if no mapping exists. The specified parameter will be passed as the argument to the function.
      parameter - the parameter to provide to function if no value exists for key
      Returns:
      the value associated with the key, if one exists, or the result of invoking function with parameter if not

    • getIfAbsentPutWithKey

      public int getIfAbsentPutWithKey​(char key, CharToIntFunction function)
      Description copied from interface: MutableCharIntMap
      Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.
      Specified by:
      getIfAbsentPutWithKey in interface MutableCharIntMap
      Parameters:
      key - the key
      function - the function that provides the value if no mapping exists. The key will be passed as the argument to the function.
      Returns:
      the value associated with the key, if one exists, or the result of invoking function with key if not

    • addToValue

      public int addToValue​(char key, int toBeAdded)
      Description copied from interface: MutableCharIntMap
      Increments and updates the value associated with the key, if a value exists, or sets the value to be the specified value if one does not.
      Specified by:
      addToValue in interface MutableCharIntMap
      Parameters:
      key - the key
      toBeAdded - the amount to increment the existing value, if one exists, or to use as the initial value if one does not
      Returns:
      the value after incrementing toBeAdded to the existing value associated with key or toBeAdded if one does not

    • updateValue

      public int updateValue​(char key, int initialValueIfAbsent, IntToIntFunction function)
      Description copied from interface: MutableCharIntMap
      Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or to the specified initial value if one does not.
      Specified by:
      updateValue in interface MutableCharIntMap
      Parameters:
      key - the key
      initialValueIfAbsent - the initial value to supply to the function if no mapping exists for the key
      function - the function that returns the updated value based on the current value or the initial value, if no value exists
      Returns:
      the new value associated with the key, either as a result of applying function to the value already associated with the key or as a result of applying it to initialValueIfAbsent and associating the result with key

    • withKeyValue

      public CharIntHashMap withKeyValue​(char key1, int value1)
      Description copied from interface: MutableCharIntMap
      Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.
      Specified by:
      withKeyValue in interface MutableCharIntMap
      Parameters:
      key1 - the key
      value1 - the value to associate with value
      Returns:
      this map
      See Also:
      MutableCharIntMap.put(char, int)

    • withKeysValues

      public CharIntHashMap withKeysValues​(char key1, int value1, char key2, int value2)

    • withKeysValues

      public CharIntHashMap withKeysValues​(char key1, int value1, char key2, int value2, char key3, int value3)

    • withKeysValues

      public CharIntHashMap withKeysValues​(char key1, int value1, char key2, int value2, char key3, int value3, char key4, int value4)

    • withoutKey

      public CharIntHashMap withoutKey​(char key)
      Description copied from interface: MutableCharIntMap
      Removes the mapping associated with the key, if one exists, from this map.
      Specified by:
      withoutKey in interface MutableCharIntMap
      Parameters:
      key - the key to remove
      Returns:
      this map
      See Also:
      MutableCharIntMap.remove(char)

    • withoutAllKeys

      public CharIntHashMap withoutAllKeys​(CharIterable keys)
      Description copied from interface: MutableCharIntMap
      Removes the mappings associated with all the keys, if they exist, from this map.
      Specified by:
      withoutAllKeys in interface MutableCharIntMap
      Parameters:
      keys - the keys to remove
      Returns:
      this map
      See Also:
      MutableCharIntMap.remove(char)

    • asUnmodifiable

      public MutableCharIntMap asUnmodifiable()
      Description copied from interface: MutableCharIntMap
      Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations. This avoids the overhead of copying the map when calling CharIntMap.toImmutable() while still providing immutability.
      Specified by:
      asUnmodifiable in interface MutableCharIntMap
      Returns:
      an unmodifiable view of this map

    • asSynchronized

      public MutableCharIntMap asSynchronized()
      Description copied from interface: MutableCharIntMap
      Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.
      Specified by:
      asSynchronized in interface MutableCharIntMap
      Returns:
      a synchronized view of this map

    • toImmutable

      public ImmutableCharIntMap toImmutable()
      Description copied from interface: CharIntMap
      Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
      Specified by:
      toImmutable in interface CharIntMap
      Returns:
      an immutable map that is equivalent to this one

    • get

      public int get​(char key)
      Description copied from interface: CharIntMap
      Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually 0) is returned.
      Specified by:
      get in interface CharIntMap
      Parameters:
      key - the key
      Returns:
      the value associated with the key, or the default value if no such mapping exists

    • getIfAbsent

      public int getIfAbsent​(char key, int ifAbsent)
      Description copied from interface: CharIntMap
      Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
      Specified by:
      getIfAbsent in interface CharIntMap
      Parameters:
      key - the key
      ifAbsent - the default value to return if no mapping exists for key
      Returns:
      the value associated with the key, or ifAbsent if no such mapping exists.

    • getOrThrow

      public int getOrThrow​(char key)
      Description copied from interface: CharIntMap
      Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
      Specified by:
      getOrThrow in interface CharIntMap
      Parameters:
      key - the key
      Returns:
      the value associated with the key

    • containsKey

      public boolean containsKey​(char key)
      Description copied from interface: CharIntMap
      Returns whether or not the key is present in the map.
      Specified by:
      containsKey in interface CharIntMap
      Specified by:
      containsKey in interface CharKeysMap
      Parameters:
      key - the key
      Returns:
      if a mapping exists in this map for the key

    • forEachKey

      public void forEachKey​(CharProcedure procedure)
      Description copied from interface: CharIntMap
      Iterates through each key in the map, invoking the procedure for each.
      Specified by:
      forEachKey in interface CharIntMap
      Specified by:
      forEachKey in interface CharKeysMap
      Parameters:
      procedure - the procedure to invoke for each key

    • forEachKeyValue

      public void forEachKeyValue​(CharIntProcedure procedure)
      Description copied from interface: CharIntMap
      Iterates through each key/value pair in the map, invoking the procedure for each.
      Specified by:
      forEachKeyValue in interface CharIntMap
      Parameters:
      procedure - the procedure to invoke for each key/value pair

    • keysView

      public LazyCharIterable keysView()
      Description copied from interface: CharIntMap
      Returns a view of the keys in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the keys returned by the iterable.
      Specified by:
      keysView in interface CharIntMap
      Returns:
      a view of the keys in this map

    • keyValuesView

      public RichIterable<CharIntPair> keyValuesView()
      Description copied from interface: CharIntMap
      Returns a view of the key/value pairs in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the pairs returned by the iterable.
      Specified by:
      keyValuesView in interface CharIntMap
      Returns:
      a view of the keys in this map

    • flipUniqueValues

      public MutableIntCharMap flipUniqueValues()
      Description copied from interface: CharIntMap
      Return the IntCharMap that is obtained by flipping the direction of this map and making the associations from value to key.
      Specified by:
      flipUniqueValues in interface CharIntMap
      Specified by:
      flipUniqueValues in interface MutableCharIntMap

    • select

      public CharIntHashMap select​(CharIntPredicate predicate)
      Description copied from interface: CharIntMap
      Return a copy of this map containing only the key/value pairs that match the predicate.
      Specified by:
      select in interface CharIntMap
      Specified by:
      select in interface MutableCharIntMap
      Parameters:
      predicate - the predicate to determine which key/value pairs in this map should be included in the returned map
      Returns:
      a copy of this map with the matching key/value pairs

    • reject

      public CharIntHashMap reject​(CharIntPredicate predicate)
      Description copied from interface: CharIntMap
      Return a copy of this map containing only the key/value pairs that do not match the predicate.
      Specified by:
      reject in interface CharIntMap
      Specified by:
      reject in interface MutableCharIntMap
      Parameters:
      predicate - the predicate to determine which key/value pairs in this map should be excluded from the returned map
      Returns:
      a copy of this map without the matching key/value pairs

    • writeExternal

      public void writeExternal​(ObjectOutput out) throws IOException
      Specified by:
      writeExternal in interface Externalizable
      Throws:
      IOException

    • readExternal

      public void readExternal​(ObjectInput in) throws IOException, ClassNotFoundException
      Specified by:
      readExternal in interface Externalizable
      Throws:
      IOException
      ClassNotFoundException

    • compact

      public void compact()
      Rehashes every element in the set into a new backing table of the smallest possible size and eliminating removed sentinels.

    • keySet

      public MutableCharSet keySet()
      Description copied from interface: CharIntMap
      Returns a set containing all the keys in this map. The set is backed by the map, so any modifications to the returned set will affect this map.
      Specified by:
      keySet in interface CharIntMap
      Returns:
      a mutable set containing the keys in this map

    • values

      public MutableIntCollection values()
      Description copied from interface: IntValuesMap
      Returns the values in this map as a separate collection. The returned collection is backed by the map, so any changes made to the returned collection will affect the state of this map.
      Specified by:
      values in interface IntValuesMap
      Returns:
      the values as a collection backed by this map