Package org.eclipse.collections.api.map.primitive

Interface FloatBooleanMap

All Superinterfaces:
BooleanIterable, BooleanValuesMap, PrimitiveIterable
All Known Subinterfaces:
ImmutableFloatBooleanMap, MutableFloatBooleanMap
All Known Implementing Classes:
FloatBooleanHashMap, SynchronizedFloatBooleanMap, UnmodifiableFloatBooleanMap
public interface FloatBooleanMap
extends BooleanValuesMap
This file was automatically generated from template file primitivePrimitiveMap.stg.
Since:
3.0.

  • Method Details

    • get

      boolean get​(float 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

    • getIfAbsent

      boolean getIfAbsent​(float key, boolean 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.

    • getOrThrow

      boolean getOrThrow​(float 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

    • containsKey

      boolean containsKey​(float 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

    • forEachKey

      void forEachKey​(FloatProcedure 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​(FloatBooleanProcedure 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

    • keysView

      LazyFloatIterable 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<FloatBooleanPair> 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

    • select

      FloatBooleanMap select​(FloatBooleanPredicate 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

      FloatBooleanMap reject​(FloatBooleanPredicate 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

    • equals

      boolean equals​(Object o)
      Follows the same general contract as Map.equals(Object).
      Overrides:
      equals in class Object

    • hashCode

      int hashCode()
      Follows the same general contract as Map.hashCode().
      Overrides:
      hashCode in class Object

    • 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 FloatBooleanMap
      See Also:
      AbstractCollection.toString()

    • toImmutable

      ImmutableFloatBooleanMap 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

      MutableFloatSet 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