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

Class FloatBooleanHashMap

java.lang.Object
org.eclipse.collections.impl.primitive.AbstractBooleanIterable
org.eclipse.collections.impl.map.mutable.primitive.AbstractMutableBooleanValuesMap
org.eclipse.collections.impl.map.mutable.primitive.FloatBooleanHashMap
All Implemented Interfaces:
Externalizable, Serializable, BooleanIterable, BooleanValuesMap, FloatBooleanMap, MutableBooleanValuesMap, MutableFloatBooleanMap, PrimitiveIterable, MutableFloatKeysMap, FloatKeysMap
public class FloatBooleanHashMap extends AbstractMutableBooleanValuesMap implements MutableFloatBooleanMap, MutableFloatKeysMap, Externalizable
This file was automatically generated from template file primitiveBooleanHashMap.stg.
Since:
3.0.
See Also:

  • Constructor Details

    • FloatBooleanHashMap

      public FloatBooleanHashMap()

    • FloatBooleanHashMap

      public FloatBooleanHashMap(int initialCapacity)

    • FloatBooleanHashMap

      public FloatBooleanHashMap(FloatBooleanMap map)

    • FloatBooleanHashMap

      @Deprecated public FloatBooleanHashMap(int initialCapacity, float loadFactor)
      Deprecated.
      in 5.1.0.

  • Method Details

    • asUnmodifiable

      public MutableFloatBooleanMap asUnmodifiable()
      Description copied from interface: MutableFloatBooleanMap
      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 FloatBooleanMap.toImmutable() while still providing immutability.
      Specified by:
      asUnmodifiable in interface MutableFloatBooleanMap
      Returns:
      an unmodifiable view of this map

    • asSynchronized

      public MutableFloatBooleanMap asSynchronized()
      Description copied from interface: MutableFloatBooleanMap
      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 MutableFloatBooleanMap
      Returns:
      a synchronized view of this map

    • toImmutable

      public ImmutableFloatBooleanMap toImmutable()
      Description copied from interface: FloatBooleanMap
      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 FloatBooleanMap
      Returns:
      an immutable map that is equivalent to this one

    • newWithKeysValues

      public static FloatBooleanHashMap newWithKeysValues(float key1, boolean value1)

    • newWithKeysValues

      public static FloatBooleanHashMap newWithKeysValues(float key1, boolean value1, float key2, boolean value2)

    • newWithKeysValues

      public static FloatBooleanHashMap newWithKeysValues(float key1, boolean value1, float key2, boolean value2, float key3, boolean value3)

    • newWithKeysValues

      public static FloatBooleanHashMap newWithKeysValues(float key1, boolean value1, float key2, boolean value2, float key3, boolean value3, float key4, boolean value4)

    • withKeyValue

      public FloatBooleanHashMap withKeyValue(float key1, boolean value1)
      Description copied from interface: MutableFloatBooleanMap
      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 MutableFloatBooleanMap
      Parameters:
      key1 - the key
      value1 - the value to associate with value
      Returns:
      this map
      See Also:

    • withKeysValues

      public FloatBooleanHashMap withKeysValues(float key1, boolean value1, float key2, boolean value2)

    • withKeysValues

      public FloatBooleanHashMap withKeysValues(float key1, boolean value1, float key2, boolean value2, float key3, boolean value3)

    • withKeysValues

      public FloatBooleanHashMap withKeysValues(float key1, boolean value1, float key2, boolean value2, float key3, boolean value3, float key4, boolean value4)

    • withoutKey

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

    • withoutAllKeys

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

    • compact

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

    • clear

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

    • put

      public void put(float key, boolean value)
      Description copied from interface: MutableFloatBooleanMap
      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 MutableFloatBooleanMap
      Parameters:
      key - the key
      value - the value to associate with value

    • putAll

      public void putAll(FloatBooleanMap map)
      Description copied from interface: MutableFloatBooleanMap
      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 MutableFloatBooleanMap
      Parameters:
      map - the map to copy into this map

    • updateValues

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

    • containsKey

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

    • containsValue

      public boolean containsValue(boolean value)
      Description copied from interface: BooleanValuesMap
      Returns whether or not this map contains the value.
      Specified by:
      containsValue in interface BooleanValuesMap
      Parameters:
      value - the value to test
      Returns:
      if this collection contains the value

    • get

      public boolean get(float key)
      Description copied from interface: FloatBooleanMap
      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 FloatBooleanMap
      Parameters:
      key - the key
      Returns:
      the value associated with the key, or the default value if no such mapping exists

    • getIfAbsent

      public boolean getIfAbsent(float key, boolean ifAbsent)
      Description copied from interface: FloatBooleanMap
      Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
      Specified by:
      getIfAbsent in interface FloatBooleanMap
      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 boolean getOrThrow(float key)
      Description copied from interface: FloatBooleanMap
      Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
      Specified by:
      getOrThrow in interface FloatBooleanMap
      Parameters:
      key - the key
      Returns:
      the value associated with the key

    • getIfAbsentPut

      public boolean getIfAbsentPut(float key, boolean value)
      Description copied from interface: MutableFloatBooleanMap
      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 MutableFloatBooleanMap
      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 boolean getIfAbsentPut(float key, BooleanFunction0 function)
      Description copied from interface: MutableFloatBooleanMap
      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 MutableFloatBooleanMap
      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> boolean getIfAbsentPutWith(float key, BooleanFunction<? super P> function, P parameter)
      Description copied from interface: MutableFloatBooleanMap
      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 MutableFloatBooleanMap
      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 boolean getIfAbsentPutWithKey(float key, FloatToBooleanFunction function)
      Description copied from interface: MutableFloatBooleanMap
      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 MutableFloatBooleanMap
      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

    • updateValue

      public boolean updateValue(float key, boolean initialValueIfAbsent, BooleanToBooleanFunction function)
      Description copied from interface: MutableFloatBooleanMap
      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 MutableFloatBooleanMap
      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

    • removeKey

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

    • remove

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

    • removeKeyIfAbsent

      public boolean removeKeyIfAbsent(float key, boolean value)
      Description copied from interface: MutableFloatBooleanMap
      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 MutableFloatBooleanMap
      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

    • equals

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

    • hashCode

      public int hashCode()
      Description copied from interface: FloatBooleanMap
      Follows the same general contract as Map.hashCode().
      Specified by:
      hashCode in interface FloatBooleanMap
      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 FloatBooleanMap
      Specified by:
      toString in interface PrimitiveIterable
      Overrides:
      toString in class AbstractBooleanIterable
      Returns:
      a string representation of this PrimitiveIterable
      See Also:

    • booleanIterator

      public MutableBooleanIterator booleanIterator()
      Description copied from interface: BooleanIterable
      Returns a primitive iterator that can be used to iterate over the BooleanIterable in an imperative style.
      Specified by:
      booleanIterator in interface BooleanIterable
      Specified by:
      booleanIterator in interface MutableBooleanValuesMap

    • forEachKey

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

    • forEachKeyValue

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

    • select

      public FloatBooleanHashMap select(FloatBooleanPredicate predicate)
      Description copied from interface: FloatBooleanMap
      Return a copy of this map containing only the key/value pairs that match the predicate.
      Specified by:
      select in interface FloatBooleanMap
      Specified by:
      select in interface MutableFloatBooleanMap
      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 FloatBooleanHashMap reject(FloatBooleanPredicate predicate)
      Description copied from interface: FloatBooleanMap
      Return a copy of this map containing only the key/value pairs that do not match the predicate.
      Specified by:
      reject in interface FloatBooleanMap
      Specified by:
      reject in interface MutableFloatBooleanMap
      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

    • keysView

      public LazyFloatIterable keysView()
      Description copied from interface: FloatBooleanMap
      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 FloatBooleanMap
      Returns:
      a view of the keys in this map

    • keyValuesView

      public RichIterable<FloatBooleanPair> keyValuesView()
      Description copied from interface: FloatBooleanMap
      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 FloatBooleanMap
      Returns:
      a view of the keys in this map

    • 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

    • keySet

      public MutableFloatSet keySet()
      Description copied from interface: FloatBooleanMap
      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 FloatBooleanMap
      Returns:
      a mutable set containing the keys in this map

    • values

      public MutableBooleanCollection values()
      Description copied from interface: BooleanValuesMap
      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 BooleanValuesMap
      Returns:
      the values as a collection backed by this map