java.lang.Object

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

All Implemented Interfaces:: Serializable, FloatIterable, FloatValuesMap, IntFloatMap, MutableFloatValuesMap, MutableIntFloatMap, PrimitiveIterable

public class UnmodifiableIntFloatMap
extends Object
implements MutableIntFloatMap, Serializable

This file was automatically generated from template file unmodifiablePrimitivePrimitiveMap.stg.

Since:: 3.1.
See Also:: Serialized Form

Constructor Summary

Constructors

Constructor Description

UnmodifiableIntFloatMap(MutableIntFloatMap map)

Method Summary

Modifier and Type	Method	Description
`float`	`addToValue(int key, float toBeAdded)`	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.
`boolean`	`allSatisfy(FloatPredicate predicate)`	Returns true if all of the elements in the FloatIterable return true for the specified predicate, otherwise returns false.
`boolean`	`anySatisfy(FloatPredicate predicate)`	Returns true if any of the elements in the FloatIterable return true for the specified predicate, otherwise returns false.
`void`	`appendString(Appendable appendable)`	Prints a string representation of this collection onto the given `Appendable`.
`void`	`appendString(Appendable appendable, String separator)`	Prints a string representation of this collection onto the given `Appendable`.
`void`	`appendString(Appendable appendable, String start, String separator, String end)`	Prints a string representation of this collection onto the given `Appendable`.
`LazyFloatIterable`	`asLazy()`	Returns a LazyFloatIterable adapter wrapping the source FloatIterable.
`MutableIntFloatMap`	`asSynchronized()`	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.
`MutableIntFloatMap`	`asUnmodifiable()`	Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an `UnsupportedOperationException` for all mutating operations.
`double`	`average()`
`RichIterable<FloatIterable>`	`chunk(int size)`	Partitions elements in fixed size chunks.
`void`	`clear()`	Removes all entries from this map.
`<V> MutableBag<V>`	`collect(FloatToObjectFunction<? extends V> function)`	Returns a new collection with the results of applying the specified function on each element of the source collection.
`boolean`	`contains(float value)`	Returns true if the value is contained in the FloatIterable, and false if it is not.
`boolean`	`containsAll(float... source)`	Returns true if the all of the values specified in the source array are contained in the FloatIterable, and false if they are not.
`boolean`	`containsAll(FloatIterable source)`	Returns true if the all of the values specified in the source FloatIterable are contained in the FloatIterable, and false if they are not.
`boolean`	`containsKey(int key)`	Returns whether or not the key is present in the map.
`boolean`	`containsValue(float value)`	Returns whether or not this map contains the value.
`int`	`count(FloatPredicate predicate)`	Returns a count of the number of elements in the FloatIterable that return true for the specified predicate.
`float`	`detectIfNone(FloatPredicate predicate, float ifNone)`
`void`	`each(FloatProcedure procedure)`	A synonym for forEach.
`boolean`	`equals(Object otherMap)`	Follows the same general contract as `Map.equals(Object)`.
`MutableFloatIntMap`	`flipUniqueValues()`	Return the FloatIntMap that is obtained by flipping the direction of this map and making the associations from value to key.
`MutableFloatIterator`	`floatIterator()`	Returns a primitive iterator that can be used to iterate over the FloatIterable in an imperative style.
`void`	`forEach(FloatProcedure procedure)`	Applies the FloatProcedure to each element in the FloatIterable.
`void`	`forEachKey(IntProcedure procedure)`	Iterates through each key in the map, invoking the procedure for each.
`void`	`forEachKeyValue(IntFloatProcedure procedure)`	Iterates through each key/value pair in the map, invoking the procedure for each.
`void`	`forEachValue(FloatProcedure procedure)`	Iterates through each value in this map.
`float`	`get(int key)`	Retrieves the value associated with the key.
`float`	`getIfAbsent(int key, float ifAbsent)`	Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
`float`	`getIfAbsentPut(int key, float value)`	Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
`float`	`getIfAbsentPut(int key, FloatFunction0 function)`	Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.
`<P> float`	`getIfAbsentPutWith(int key, FloatFunction<? super P> function, P parameter)`	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.
`float`	`getIfAbsentPutWithKey(int key, IntToFloatFunction function)`	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.
`float`	`getOrThrow(int key)`	Retrieves the value associated with the key, throwing an `IllegalStateException` if no such mapping exists.
`int`	`hashCode()`	Follows the same general contract as `Map.hashCode()`.
`<T> T`	`injectInto(T injectedValue, ObjectFloatToObjectFunction<? super T,? extends T> function)`
`boolean`	`isEmpty()`	Returns true if this iterable has zero items.
`MutableIntSet`	`keySet()`	Returns a set containing all the keys in this map.
`LazyIntIterable`	`keysView()`	Returns a view of the keys in this map.
`RichIterable<IntFloatPair>`	`keyValuesView()`	Returns a view of the key/value pairs in this map.
`String`	`makeString()`	Returns a string representation of this collection by delegating to `PrimitiveIterable.makeString(String)` and defaulting the separator parameter to the characters `", "` (comma and space).
`String`	`makeString(String separator)`	Returns a string representation of this collection by delegating to `PrimitiveIterable.makeString(String, String, String)` and defaulting the start and end parameters to `""` (the empty String).
`String`	`makeString(String start, String separator, String end)`	Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
`float`	`max()`
`float`	`maxIfEmpty(float defaultValue)`
`double`	`median()`
`float`	`min()`
`float`	`minIfEmpty(float defaultValue)`
`boolean`	`noneSatisfy(FloatPredicate predicate)`	Returns true if none of the elements in the FloatIterable return true for the specified predicate, otherwise returns false.
`boolean`	`notEmpty()`	The English equivalent of !this.isEmpty()
`void`	`put(int key, float value)`	Associates a value with the specified key.
`void`	`putAll(IntFloatMap map)`	Puts all of the key/value mappings from the specified map into this map.
`void`	`putPair(IntFloatPair keyValuePair)`	This method allows MutableIntFloatMap the ability to add an element in the form of IntFloatPair.
`MutableFloatBag`	`reject(FloatPredicate predicate)`	Returns a new FloatIterable with all of the elements in the FloatIterable that return false for the specified predicate.
`MutableIntFloatMap`	`reject(IntFloatPredicate predicate)`	Return a copy of this map containing only the key/value pairs that do not match the predicate.
`void`	`remove(int key)`	Removes the mapping associated with the key, if one exists, from the map.
`void`	`removeKey(int key)`	Removes the mapping associated with the key, if one exists, from the map.
`float`	`removeKeyIfAbsent(int key, float value)`	Removes the mapping associated with the key, if one exists, from the map, returning the previously associated value with the key.
`MutableFloatBag`	`select(FloatPredicate predicate)`	Returns a new FloatIterable with all of the elements in the FloatIterable that return true for the specified predicate.
`MutableIntFloatMap`	`select(IntFloatPredicate predicate)`	Return a copy of this map containing only the key/value pairs that match the predicate.
`int`	`size()`	Returns the number of items in this iterable.
`double`	`sum()`
`float[]`	`toArray()`	Converts the FloatIterable to a primitive float array.
`float[]`	`toArray(float[] target)`	Converts the FloatIterable to a primitive float array.
`MutableFloatBag`	`toBag()`	Converts the FloatIterable to a new MutableFloatBag.
`ImmutableIntFloatMap`	`toImmutable()`	Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
`MutableFloatList`	`toList()`	Converts the FloatIterable to a new MutableFloatList.
`MutableFloatSet`	`toSet()`	Converts the FloatIterable to a new MutableFloatSet.
`float[]`	`toSortedArray()`
`MutableFloatList`	`toSortedList()`
`String`	`toString()`	Follows the same general contract as `AbstractMap.toString()`
`float`	`updateValue(int key, float initialValueIfAbsent, FloatToFloatFunction function)`	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.
`void`	`updateValues(IntFloatToFloatFunction function)`	Updates the values in-place.
`MutableFloatCollection`	`values()`	Returns the values in this map as a separate collection.
`MutableIntFloatMap`	`withKeyValue(int key, float value)`	Associates a value with the specified key.
`MutableIntFloatMap`	`withoutAllKeys(IntIterable keys)`	Removes the mappings associated with all the keys, if they exist, from this map.
`MutableIntFloatMap`	`withoutKey(int key)`	Removes the mapping associated with the key, if one exists, from this map.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.collections.api.FloatIterable

averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, flatCollect, medianIfEmpty, reduce, reduceIfEmpty, reject, select, summaryStatistics

Methods inherited from interface org.eclipse.collections.api.map.primitive.FloatValuesMap

tap

Methods inherited from interface org.eclipse.collections.api.map.primitive.MutableIntFloatMap

withAllKeyValues

Constructor Details
- UnmodifiableIntFloatMap
  
  public UnmodifiableIntFloatMap(MutableIntFloatMap map)
Method Details
- clear
  
  public void clear()
  
  Description copied from interface: MutableFloatValuesMap
  
  Removes all entries from this map.
  
  Specified by:
  
  clear in interface MutableFloatValuesMap
- put
  
  public void put(int key, float value)
  
  Description copied from interface: MutableIntFloatMap
  
  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 MutableIntFloatMap
  
  Parameters:
  
  key - the key
  
  value - the value to associate with value
- putPair
  
  public void putPair(IntFloatPair keyValuePair)
  
  Description copied from interface: MutableIntFloatMap
  
  This method allows MutableIntFloatMap the ability to add an element in the form of IntFloatPair.
  
  Specified by:
  
  putPair in interface MutableIntFloatMap
  
  See Also:
  
  MutableIntFloatMap.put(int, float)
- putAll
  
  public void putAll(IntFloatMap map)
  
  Description copied from interface: MutableIntFloatMap
  
  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 MutableIntFloatMap
  
  Parameters:
  
  map - the map to copy into this map
- updateValues
  
  public void updateValues(IntFloatToFloatFunction function)
  
  Description copied from interface: MutableIntFloatMap
  
  Updates the values in-place.
  
  Specified by:
  
  updateValues in interface MutableIntFloatMap
  
  Parameters:
  
  function - that takes a key and its value and that returns a new value for this key
- removeKey
  
  public void removeKey(int key)
  
  Description copied from interface: MutableIntFloatMap
  
  Removes the mapping associated with the key, if one exists, from the map.
  
  Specified by:
  
  removeKey in interface MutableIntFloatMap
  
  Parameters:
  
  key - the key to remove
  
  See Also:
  
  MutableIntFloatMap.remove(int)
- remove
  
  public void remove(int key)
  
  Description copied from interface: MutableIntFloatMap
  
  Removes the mapping associated with the key, if one exists, from the map.
  
  Specified by:
  
  remove in interface MutableIntFloatMap
  
  Parameters:
  
  key - the key to remove
  
  See Also:
  
  MutableIntFloatMap.removeKey(int)
- removeKeyIfAbsent
  
  public float removeKeyIfAbsent(int key, float value)
  
  Description copied from interface: MutableIntFloatMap
  
  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 MutableIntFloatMap
  
  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 float getIfAbsentPut(int key, float value)
  
  Description copied from interface: MutableIntFloatMap
  
  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 MutableIntFloatMap
  
  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 float getIfAbsentPut(int key, FloatFunction0 function)
  
  Description copied from interface: MutableIntFloatMap
  
  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 MutableIntFloatMap
  
  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
- getIfAbsentPutWithKey
  
  public float getIfAbsentPutWithKey(int key, IntToFloatFunction function)
  
  Description copied from interface: MutableIntFloatMap
  
  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 MutableIntFloatMap
  
  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
- getIfAbsentPutWith
  
  public <P> float getIfAbsentPutWith(int key, FloatFunction<? super P> function, P parameter)
  
  Description copied from interface: MutableIntFloatMap
  
  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 MutableIntFloatMap
  
  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
- updateValue
  
  public float updateValue(int key, float initialValueIfAbsent, FloatToFloatFunction function)
  
  Description copied from interface: MutableIntFloatMap
  
  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 MutableIntFloatMap
  
  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
- get
  
  public float get(int key)
  
  Description copied from interface: IntFloatMap
  
  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 IntFloatMap
  
  Parameters:
  
  key - the key
  
  Returns:
  
  the value associated with the key, or the default value if no such mapping exists
- getIfAbsent
  
  public float getIfAbsent(int key, float ifAbsent)
  
  Description copied from interface: IntFloatMap
  
  Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
  
  Specified by:
  
  getIfAbsent in interface IntFloatMap
  
  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 float getOrThrow(int key)
  
  Description copied from interface: IntFloatMap
  
  Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
  
  Specified by:
  
  getOrThrow in interface IntFloatMap
  
  Parameters:
  
  key - the key
  
  Returns:
  
  the value associated with the key
- containsKey
  
  public boolean containsKey(int key)
  
  Description copied from interface: IntFloatMap
  
  Returns whether or not the key is present in the map.
  
  Specified by:
  
  containsKey in interface IntFloatMap
  
  Parameters:
  
  key - the key
  
  Returns:
  
  if a mapping exists in this map for the key
- containsValue
  
  public boolean containsValue(float value)
  
  Description copied from interface: FloatValuesMap
  
  Returns whether or not this map contains the value.
  
  Specified by:
  
  containsValue in interface FloatValuesMap
  
  Parameters:
  
  value - the value to test
  
  Returns:
  
  if this collection contains the value
- forEachValue
  
  public void forEachValue(FloatProcedure procedure)
  
  Description copied from interface: FloatValuesMap
  
  Iterates through each value in this map.
  
  Specified by:
  
  forEachValue in interface FloatValuesMap
  
  Parameters:
  
  procedure - the procedure to invoke for each value in this map.
- forEachKey
  
  public void forEachKey(IntProcedure procedure)
  
  Description copied from interface: IntFloatMap
  
  Iterates through each key in the map, invoking the procedure for each.
  
  Specified by:
  
  forEachKey in interface IntFloatMap
  
  Parameters:
  
  procedure - the procedure to invoke for each key
- forEachKeyValue
  
  public void forEachKeyValue(IntFloatProcedure procedure)
  
  Description copied from interface: IntFloatMap
  
  Iterates through each key/value pair in the map, invoking the procedure for each.
  
  Specified by:
  
  forEachKeyValue in interface IntFloatMap
  
  Parameters:
  
  procedure - the procedure to invoke for each key/value pair
- keysView
  
  public LazyIntIterable keysView()
  
  Description copied from interface: IntFloatMap
  
  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 IntFloatMap
  
  Returns:
  
  a view of the keys in this map
- keyValuesView
  
  public RichIterable<IntFloatPair> keyValuesView()
  
  Description copied from interface: IntFloatMap
  
  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 IntFloatMap
  
  Returns:
  
  a view of the keys in this map
- flipUniqueValues
  
  public MutableFloatIntMap flipUniqueValues()
  
  Description copied from interface: IntFloatMap
  
  Return the FloatIntMap that is obtained by flipping the direction of this map and making the associations from value to key.
  
  Specified by:
  
  flipUniqueValues in interface IntFloatMap
  
  Specified by:
  
  flipUniqueValues in interface MutableIntFloatMap
- select
  
  public MutableIntFloatMap select(IntFloatPredicate predicate)
  
  Description copied from interface: IntFloatMap
  
  Return a copy of this map containing only the key/value pairs that match the predicate.
  
  Specified by:
  
  select in interface IntFloatMap
  
  Specified by:
  
  select in interface MutableIntFloatMap
  
  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 MutableIntFloatMap reject(IntFloatPredicate predicate)
  
  Description copied from interface: IntFloatMap
  
  Return a copy of this map containing only the key/value pairs that do not match the predicate.
  
  Specified by:
  
  reject in interface IntFloatMap
  
  Specified by:
  
  reject in interface MutableIntFloatMap
  
  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
- floatIterator
  
  public MutableFloatIterator floatIterator()
  
  Description copied from interface: FloatIterable
  
  Returns a primitive iterator that can be used to iterate over the FloatIterable in an imperative style.
  
  Specified by:
  
  floatIterator in interface FloatIterable
  
  Specified by:
  
  floatIterator in interface MutableFloatValuesMap
- forEach
  
  public void forEach(FloatProcedure procedure)
  
  Description copied from interface: FloatIterable
  
  Applies the FloatProcedure to each element in the FloatIterable.
  
  Specified by:
  
  forEach in interface FloatIterable
- each
  
  public void each(FloatProcedure procedure)
  
  Description copied from interface: FloatIterable
  
  A synonym for forEach.
  
  Specified by:
  
  each in interface FloatIterable
  
  Since:
  
  7.0.
- count
  
  public int count(FloatPredicate predicate)
  
  Description copied from interface: FloatIterable
  
  Returns a count of the number of elements in the FloatIterable that return true for the specified predicate.
  
  Specified by:
  
  count in interface FloatIterable
- anySatisfy
  
  public boolean anySatisfy(FloatPredicate predicate)
  
  Description copied from interface: FloatIterable
  
  Returns true if any of the elements in the FloatIterable return true for the specified predicate, otherwise returns false.
  
  Specified by:
  
  anySatisfy in interface FloatIterable
- allSatisfy
  
  public boolean allSatisfy(FloatPredicate predicate)
  
  Description copied from interface: FloatIterable
  
  Returns true if all of the elements in the FloatIterable return true for the specified predicate, otherwise returns false.
  
  Specified by:
  
  allSatisfy in interface FloatIterable
- noneSatisfy
  
  public boolean noneSatisfy(FloatPredicate predicate)
  
  Description copied from interface: FloatIterable
  
  Returns true if none of the elements in the FloatIterable return true for the specified predicate, otherwise returns false.
  
  Specified by:
  
  noneSatisfy in interface FloatIterable
- select
  
  public MutableFloatBag select(FloatPredicate predicate)
  
  Description copied from interface: FloatIterable
  
  Returns a new FloatIterable with all of the elements in the FloatIterable that return true for the specified predicate.
  
  Specified by:
  
  select in interface FloatIterable
  
  Specified by:
  
  select in interface FloatValuesMap
  
  Specified by:
  
  select in interface MutableFloatValuesMap
- reject
  
  public MutableFloatBag reject(FloatPredicate predicate)
  
  Description copied from interface: FloatIterable
  
  Returns a new FloatIterable with all of the elements in the FloatIterable that return false for the specified predicate.
  
  Specified by:
  
  reject in interface FloatIterable
  
  Specified by:
  
  reject in interface FloatValuesMap
  
  Specified by:
  
  reject in interface MutableFloatValuesMap
- collect
  
  public <V> MutableBag<V> collect(FloatToObjectFunction<? extends V> function)
  
  Description copied from interface: FloatIterable
  
  Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
  
  Specified by:
  
  collect in interface FloatIterable
  
  Specified by:
  
  collect in interface FloatValuesMap
  
  Specified by:
  
  collect in interface MutableFloatValuesMap
- detectIfNone
  
  public float detectIfNone(FloatPredicate predicate, float ifNone)
  
  Specified by:
  
  detectIfNone in interface FloatIterable
- sum
  
  public double sum()
  
  Specified by:
  
  sum in interface FloatIterable
- max
  
  public float max()
  
  Specified by:
  
  max in interface FloatIterable
- maxIfEmpty
  
  public float maxIfEmpty(float defaultValue)
  
  Specified by:
  
  maxIfEmpty in interface FloatIterable
- min
  
  public float min()
  
  Specified by:
  
  min in interface FloatIterable
- minIfEmpty
  
  public float minIfEmpty(float defaultValue)
  
  Specified by:
  
  minIfEmpty in interface FloatIterable
- average
  
  public double average()
  
  Specified by:
  
  average in interface FloatIterable
- median
  
  public double median()
  
  Specified by:
  
  median in interface FloatIterable
- addToValue
  
  public float addToValue(int key, float toBeAdded)
  
  Description copied from interface: MutableIntFloatMap
  
  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 MutableIntFloatMap
  
  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
- toSortedArray
  
  public float[] toSortedArray()
  
  Specified by:
  
  toSortedArray in interface FloatIterable
- toSortedList
  
  public MutableFloatList toSortedList()
  
  Specified by:
  
  toSortedList in interface FloatIterable
- toArray
  
  public float[] toArray()
  
  Description copied from interface: FloatIterable
  
  Converts the FloatIterable to a primitive float array.
  
  Specified by:
  
  toArray in interface FloatIterable
- toArray
  
  public float[] toArray(float[] target)
  
  Description copied from interface: FloatIterable
  
  Converts the FloatIterable to a primitive float array. If the collection fits into the provided array it is used to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated and returned. If the iterable is empty, the target array is returned unchanged.
  
  Specified by:
  
  toArray in interface FloatIterable
- contains
  
  public boolean contains(float value)
  
  Description copied from interface: FloatIterable
  
  Returns true if the value is contained in the FloatIterable, and false if it is not.
  
  Specified by:
  
  contains in interface FloatIterable
- containsAll
  
  public boolean containsAll(float... source)
  
  Description copied from interface: FloatIterable
  
  Returns true if the all of the values specified in the source array are contained in the FloatIterable, and false if they are not.
  
  Specified by:
  
  containsAll in interface FloatIterable
- containsAll
  
  public boolean containsAll(FloatIterable source)
  
  Description copied from interface: FloatIterable
  
  Returns true if the all of the values specified in the source FloatIterable are contained in the FloatIterable, and false if they are not.
  
  Specified by:
  
  containsAll in interface FloatIterable
- toList
  
  public MutableFloatList toList()
  
  Description copied from interface: FloatIterable
  
  Converts the FloatIterable to a new MutableFloatList.
  
  Specified by:
  
  toList in interface FloatIterable
- toSet
  
  public MutableFloatSet toSet()
  
  Description copied from interface: FloatIterable
  
  Converts the FloatIterable to a new MutableFloatSet.
  
  Specified by:
  
  toSet in interface FloatIterable
- toBag
  
  public MutableFloatBag toBag()
  
  Description copied from interface: FloatIterable
  
  Converts the FloatIterable to a new MutableFloatBag.
  
  Specified by:
  
  toBag in interface FloatIterable
- asLazy
  
  public LazyFloatIterable asLazy()
  
  Description copied from interface: FloatIterable
  
  Returns a LazyFloatIterable adapter wrapping the source FloatIterable.
  
  Specified by:
  
  asLazy in interface FloatIterable
- withKeyValue
  
  public MutableIntFloatMap withKeyValue(int key, float value)
  
  Description copied from interface: MutableIntFloatMap
  
  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 MutableIntFloatMap
  
  Parameters:
  
  key - the key
  
  value - the value to associate with value
  
  Returns:
  
  this map
  
  See Also:
  
  MutableIntFloatMap.put(int, float)
- withoutKey
  
  public MutableIntFloatMap withoutKey(int key)
  
  Description copied from interface: MutableIntFloatMap
  
  Removes the mapping associated with the key, if one exists, from this map.
  
  Specified by:
  
  withoutKey in interface MutableIntFloatMap
  
  Parameters:
  
  key - the key to remove
  
  Returns:
  
  this map
  
  See Also:
  
  MutableIntFloatMap.remove(int)
- withoutAllKeys
  
  public MutableIntFloatMap withoutAllKeys(IntIterable keys)
  
  Description copied from interface: MutableIntFloatMap
  
  Removes the mappings associated with all the keys, if they exist, from this map.
  
  Specified by:
  
  withoutAllKeys in interface MutableIntFloatMap
  
  Parameters:
  
  keys - the keys to remove
  
  Returns:
  
  this map
  
  See Also:
  
  MutableIntFloatMap.remove(int)
- asUnmodifiable
  
  public MutableIntFloatMap asUnmodifiable()
  
  Description copied from interface: MutableIntFloatMap
  
  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 IntFloatMap.toImmutable() while still providing immutability.
  
  Specified by:
  
  asUnmodifiable in interface MutableIntFloatMap
  
  Returns:
  
  an unmodifiable view of this map
- asSynchronized
  
  public MutableIntFloatMap asSynchronized()
  
  Description copied from interface: MutableIntFloatMap
  
  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 MutableIntFloatMap
  
  Returns:
  
  a synchronized view of this map
- toImmutable
  
  public ImmutableIntFloatMap toImmutable()
  
  Description copied from interface: IntFloatMap
  
  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 IntFloatMap
  
  Returns:
  
  an immutable map that is equivalent to this one
- size
  
  public int size()
  
  Description copied from interface: PrimitiveIterable
  
  Returns the number of items in this iterable.
  
  Specified by:
  
  size in interface PrimitiveIterable
- isEmpty
  
  public boolean isEmpty()
  
  Description copied from interface: PrimitiveIterable
  
  Returns true if this iterable has zero items.
  
  Specified by:
  
  isEmpty in interface PrimitiveIterable
- notEmpty
  
  public boolean notEmpty()
  
  Description copied from interface: PrimitiveIterable
  
  The English equivalent of !this.isEmpty()
  
  Specified by:
  
  notEmpty in interface PrimitiveIterable
- keySet
  
  public MutableIntSet keySet()
  
  Description copied from interface: IntFloatMap
  
  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 IntFloatMap
  
  Returns:
  
  a mutable set containing the keys in this map
- values
  
  public MutableFloatCollection values()
  
  Description copied from interface: FloatValuesMap
  
  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 FloatValuesMap
  
  Returns:
  
  the values as a collection backed by this map
- equals
  
  public boolean equals(Object otherMap)
  
  Description copied from interface: IntFloatMap
  
  Follows the same general contract as Map.equals(Object).
  
  Specified by:
  
  equals in interface IntFloatMap
  
  Overrides:
  
  equals in class Object
- hashCode
  
  public int hashCode()
  
  Description copied from interface: IntFloatMap
  
  Follows the same general contract as Map.hashCode().
  
  Specified by:
  
  hashCode in interface IntFloatMap
  
  Overrides:
  
  hashCode in class Object
- toString
  
  public String toString()
  
  Description copied from interface: IntFloatMap
  
  Follows the same general contract as AbstractMap.toString()
  
  Specified by:
  
  toString in interface IntFloatMap
  
  Specified by:
  
  toString in interface PrimitiveIterable
  
  Overrides:
  
  toString in class Object
  
  Returns:
  
  a string representation of this IntFloatMap
  
  See Also:
  
  AbstractCollection.toString()
- makeString
  
  public String makeString()
  
  Description copied from interface: PrimitiveIterable
  
  Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
  
  Specified by:
  
  makeString in interface PrimitiveIterable
  
  Returns:
  
  a string representation of this collection.
- makeString
  
  public String makeString(String separator)
  
  Description copied from interface: PrimitiveIterable
  
  Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
  
  Specified by:
  
  makeString in interface PrimitiveIterable
  
  Returns:
  
  a string representation of this collection.
- makeString
  
  public String makeString(String start, String separator, String end)
  
  Description copied from interface: PrimitiveIterable
  
  Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
  
  Specified by:
  
  makeString in interface PrimitiveIterable
  
  Returns:
  
  a string representation of this collection.
- appendString
  
  public void appendString(Appendable appendable)
  
  Description copied from interface: PrimitiveIterable
  
  Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString().
  
  Specified by:
  
  appendString in interface PrimitiveIterable
- appendString
  
  public void appendString(Appendable appendable, String separator)
  
  Description copied from interface: PrimitiveIterable
  
  Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String).
  
  Specified by:
  
  appendString in interface PrimitiveIterable
- appendString
  
  public void appendString(Appendable appendable, String start, String separator, String end)
  
  Description copied from interface: PrimitiveIterable
  
  Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String, String, String).
  
  Specified by:
  
  appendString in interface PrimitiveIterable
- injectInto
  
  public <T> T injectInto(T injectedValue, ObjectFloatToObjectFunction<? super T,? extends T> function)
  
  Specified by:
  
  injectInto in interface FloatIterable
- chunk
  
  public RichIterable<FloatIterable> chunk(int size)
  
  Description copied from interface: FloatIterable
  
  Partitions elements in fixed size chunks.
  
  Specified by:
  
  chunk in interface FloatIterable
  
  Parameters:
  
  size - the number of elements per chunk
  
  Returns:
  
  A RichIterable containing FloatIterables of size size, except the last will be truncated if the elements don't divide evenly.

Class UnmodifiableIntFloatMap

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.eclipse.collections.api.FloatIterable

Methods inherited from interface org.eclipse.collections.api.map.primitive.FloatValuesMap

Methods inherited from interface org.eclipse.collections.api.map.primitive.MutableIntFloatMap

Constructor Details

Method Details