Interface ObjectCharMap<K>

All Superinterfaces:
CharIterable, PrimitiveIterable
All Known Subinterfaces:
ImmutableObjectCharMap<K>, MutableObjectCharMap<K>
All Known Implementing Classes:
AbstractImmutableObjectCharMap, ObjectCharHashMap, ObjectCharHashMapWithHashingStrategy, SynchronizedObjectCharMap, UnmodifiableObjectCharMap

public interface ObjectCharMap<K> extends CharIterable
This file was automatically generated from template file objectPrimitiveMap.stg.
Since:
3.0.
  • Method Details

    • get

      char get(Object key)
      Retrieves the value associated with the key. If no mapping exists for the key, the default value (usually 0) is returned.
      Parameters:
      key - the key
      Returns:
      the value associated with the key, or the default value if no such mapping exists
    • getOrThrow

      char getOrThrow(Object key)
      Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
      Parameters:
      key - the key
      Returns:
      the value associated with the key
      Throws:
      IllegalStateException - if no mapping exists for the key
    • getIfAbsent

      char getIfAbsent(Object key, char ifAbsent)
      Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
      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.
    • containsKey

      boolean containsKey(Object key)
      Returns whether or not the key is present in the map.
      Parameters:
      key - the key
      Returns:
      if a mapping exists in this map for the key
    • containsValue

      boolean containsValue(char value)
      Returns whether or not this map contains the value.
      Parameters:
      value - the value to test
      Returns:
      if this collection contains the value
    • forEachValue

      void forEachValue(CharProcedure procedure)
      Iterates through each value in this map.
      Parameters:
      procedure - the procedure to invoke for each value in this map.
    • forEachKey

      void forEachKey(Procedure<? super K> procedure)
      Iterates through each key in the map, invoking the procedure for each.
      Parameters:
      procedure - the procedure to invoke for each key
    • forEachKeyValue

      void forEachKeyValue(ObjectCharProcedure<? super K> procedure)
      Iterates through each key/value pair in the map, invoking the procedure for each.
      Parameters:
      procedure - the procedure to invoke for each key/value pair
    • flipUniqueValues

      CharObjectMap<K> flipUniqueValues()
      Return the CharObjectMap that is obtained by flipping the direction of this map and making the associations from value to key.
      Throws:
      IllegalStateException - if the CharObjectMap contains duplicate values.
      Since:
      9.0
    • injectIntoKeyValue

      default <IV> IV injectIntoKeyValue(IV injectedValue, ObjectObjectCharToObjectFunction<? super IV,? super K,? extends IV> function)
      Implements the injectInto pattern with each key/value pair of the map.
      Parameters:
      value - to be injected into the map
      function - to apply to the injected value and key/value pairs
      Returns:
      result of injecting the injectedValue into the map
      Since:
      11.1
    • select

      ObjectCharMap<K> select(ObjectCharPredicate<? super K> predicate)
      Return a copy of this map containing only the key/value pairs that match the predicate.
      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

      ObjectCharMap<K> reject(ObjectCharPredicate<? super K> predicate)
      Return a copy of this map containing only the key/value pairs that do not match the predicate.
      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
    • tap

      default ObjectCharMap<K> tap(CharProcedure procedure)
      Specified by:
      tap in interface CharIterable
      Since:
      9.0.
    • toString

      String toString()
      Follows the same general contract as AbstractMap.toString()
      Specified by:
      toString in interface PrimitiveIterable
      Overrides:
      toString in class Object
      Returns:
      a string representation of this ObjectCharMap
      See Also:
    • toImmutable

      ImmutableObjectCharMap<K> toImmutable()
      Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
      Returns:
      an immutable map that is equivalent to this one
    • keySet

      Set<K> keySet()
      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.
      Returns:
      a mutable set containing the keys in this map
    • values

      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.
      Returns:
      the values as a collection backed by this map
    • keysView

      LazyIterable<K> keysView()
      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.
      Returns:
      a view of the keys in this map
      Since:
      5.0
    • keyValuesView

      RichIterable<ObjectCharPair<K>> keyValuesView()
      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.
      Returns:
      a view of the keys in this map
      Since:
      5.0