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

Class UnmodifiableIntIntMap

java.lang.Object
org.eclipse.collections.impl.map.mutable.primitive.UnmodifiableIntIntMap
All Implemented Interfaces:
Serializable, IntIterable, IntIntMap, IntValuesMap, MutableIntIntMap, MutableIntValuesMap, PrimitiveIterable
public class UnmodifiableIntIntMap
extends Object
implements MutableIntIntMap, Serializable
This file was automatically generated from template file unmodifiablePrimitivePrimitiveMap.stg.
Since:
3.1.
See Also:
Serialized Form

  • Constructor Details

  • Method Details

    • clear

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

    • put

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

    • putPair

      public void putPair​(IntIntPair keyValuePair)
      Description copied from interface: MutableIntIntMap
      This method allows MutableIntIntMap the ability to add an element in the form of IntIntPair.
      Specified by:
      putPair in interface MutableIntIntMap
      See Also:
      MutableIntIntMap.put(int, int)

    • putAll

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

    • updateValues

      public void updateValues​(IntIntToIntFunction function)
      Description copied from interface: MutableIntIntMap
      Updates the values in-place.
      Specified by:
      updateValues in interface MutableIntIntMap
      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: MutableIntIntMap
      Removes the mapping associated with the key, if one exists, from the map.
      Specified by:
      removeKey in interface MutableIntIntMap
      Parameters:
      key - the key to remove
      See Also:
      MutableIntIntMap.remove(int)

    • remove

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

    • removeKeyIfAbsent

      public int removeKeyIfAbsent​(int key, int value)
      Description copied from interface: MutableIntIntMap
      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 MutableIntIntMap
      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​(int key, int value)
      Description copied from interface: MutableIntIntMap
      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 MutableIntIntMap
      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​(int key, IntFunction0 function)
      Description copied from interface: MutableIntIntMap
      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 MutableIntIntMap
      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 int getIfAbsentPutWithKey​(int key, IntToIntFunction function)
      Description copied from interface: MutableIntIntMap
      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 MutableIntIntMap
      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> int getIfAbsentPutWith​(int key, IntFunction<? super P> function, P parameter)
      Description copied from interface: MutableIntIntMap
      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 MutableIntIntMap
      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 int updateValue​(int key, int initialValueIfAbsent, IntToIntFunction function)
      Description copied from interface: MutableIntIntMap
      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 MutableIntIntMap
      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 int get​(int key)
      Description copied from interface: IntIntMap
      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 IntIntMap
      Parameters:
      key - the key
      Returns:
      the value associated with the key, or the default value if no such mapping exists

    • getIfAbsent

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

    • containsKey

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

    • containsValue

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

    • forEachValue

      public void forEachValue​(IntProcedure procedure)
      Description copied from interface: IntValuesMap
      Iterates through each value in this map.
      Specified by:
      forEachValue in interface IntValuesMap
      Parameters:
      procedure - the procedure to invoke for each value in this map.

    • forEachKey

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

    • forEachKeyValue

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

    • keysView

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

    • keyValuesView

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

    • flipUniqueValues

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

    • select

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

    • 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

    • forEach

      public void forEach​(IntProcedure procedure)
      Description copied from interface: IntIterable
      Applies the IntProcedure to each element in the IntIterable.
      Specified by:
      forEach in interface IntIterable

    • each

      public void each​(IntProcedure procedure)
      Description copied from interface: IntIterable
      A synonym for forEach.
      Specified by:
      each in interface IntIterable
      Since:
      7.0.

    • count

      public int count​(IntPredicate predicate)
      Description copied from interface: IntIterable
      Returns a count of the number of elements in the IntIterable that return true for the specified predicate.
      Specified by:
      count in interface IntIterable

    • anySatisfy

      public boolean anySatisfy​(IntPredicate predicate)
      Description copied from interface: IntIterable
      Returns true if any of the elements in the IntIterable return true for the specified predicate, otherwise returns false.
      Specified by:
      anySatisfy in interface IntIterable

    • allSatisfy

      public boolean allSatisfy​(IntPredicate predicate)
      Description copied from interface: IntIterable
      Returns true if all of the elements in the IntIterable return true for the specified predicate, otherwise returns false.
      Specified by:
      allSatisfy in interface IntIterable

    • noneSatisfy

      public boolean noneSatisfy​(IntPredicate predicate)
      Description copied from interface: IntIterable
      Returns true if none of the elements in the IntIterable return true for the specified predicate, otherwise returns false.
      Specified by:
      noneSatisfy in interface IntIterable

    • select

      public MutableIntBag select​(IntPredicate predicate)
      Description copied from interface: IntIterable
      Returns a new IntIterable with all of the elements in the IntIterable that return true for the specified predicate.
      Specified by:
      select in interface IntIterable
      Specified by:
      select in interface IntValuesMap
      Specified by:
      select in interface MutableIntValuesMap

    • reject

      public MutableIntBag reject​(IntPredicate predicate)
      Description copied from interface: IntIterable
      Returns a new IntIterable with all of the elements in the IntIterable that return false for the specified predicate.
      Specified by:
      reject in interface IntIterable
      Specified by:
      reject in interface IntValuesMap
      Specified by:
      reject in interface MutableIntValuesMap

    • collect

      public <V> MutableBag<V> collect​(IntToObjectFunction<? extends V> function)
      Description copied from interface: IntIterable
      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 IntIterable
      Specified by:
      collect in interface IntValuesMap
      Specified by:
      collect in interface MutableIntValuesMap

    • detectIfNone

      public int detectIfNone​(IntPredicate predicate, int ifNone)
      Specified by:
      detectIfNone in interface IntIterable

    • sum

      public long sum()
      Specified by:
      sum in interface IntIterable

    • max

      public int max()
      Specified by:
      max in interface IntIterable

    • maxIfEmpty

      public int maxIfEmpty​(int defaultValue)
      Specified by:
      maxIfEmpty in interface IntIterable

    • min

      public int min()
      Specified by:
      min in interface IntIterable

    • minIfEmpty

      public int minIfEmpty​(int defaultValue)
      Specified by:
      minIfEmpty in interface IntIterable

    • average

      public double average()
      Specified by:
      average in interface IntIterable

    • median

      public double median()
      Specified by:
      median in interface IntIterable

    • addToValue

      public int addToValue​(int key, int toBeAdded)
      Description copied from interface: MutableIntIntMap
      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 MutableIntIntMap
      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 int[] toSortedArray()
      Specified by:
      toSortedArray in interface IntIterable

    • toSortedList

      public MutableIntList toSortedList()
      Specified by:
      toSortedList in interface IntIterable

    • toArray

      public int[] toArray()
      Description copied from interface: IntIterable
      Converts the IntIterable to a primitive int array.
      Specified by:
      toArray in interface IntIterable

    • toArray

      public int[] toArray​(int[] target)
      Description copied from interface: IntIterable
      Converts the IntIterable to a primitive int 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 IntIterable

    • contains

      public boolean contains​(int value)
      Description copied from interface: IntIterable
      Returns true if the value is contained in the IntIterable, and false if it is not.
      Specified by:
      contains in interface IntIterable

    • containsAll

      public boolean containsAll​(int... source)
      Description copied from interface: IntIterable
      Returns true if the all of the values specified in the source array are contained in the IntIterable, and false if they are not.
      Specified by:
      containsAll in interface IntIterable

    • containsAll

      public boolean containsAll​(IntIterable source)
      Description copied from interface: IntIterable
      Returns true if the all of the values specified in the source IntIterable are contained in the IntIterable, and false if they are not.
      Specified by:
      containsAll in interface IntIterable

    • toList

      public MutableIntList toList()
      Description copied from interface: IntIterable
      Converts the IntIterable to a new MutableIntList.
      Specified by:
      toList in interface IntIterable

    • toSet

      public MutableIntSet toSet()
      Description copied from interface: IntIterable
      Converts the IntIterable to a new MutableIntSet.
      Specified by:
      toSet in interface IntIterable

    • toBag

      public MutableIntBag toBag()
      Description copied from interface: IntIterable
      Converts the IntIterable to a new MutableIntBag.
      Specified by:
      toBag in interface IntIterable

    • asLazy

      public LazyIntIterable asLazy()
      Description copied from interface: IntIterable
      Returns a LazyIntIterable adapter wrapping the source IntIterable.
      Specified by:
      asLazy in interface IntIterable

    • withKeyValue

      public MutableIntIntMap withKeyValue​(int key, int value)
      Description copied from interface: MutableIntIntMap
      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 MutableIntIntMap
      Parameters:
      key - the key
      value - the value to associate with value
      Returns:
      this map
      See Also:
      MutableIntIntMap.put(int, int)

    • withoutKey

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

    • withoutAllKeys

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

    • asUnmodifiable

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

    • asSynchronized

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

    • toImmutable

      public ImmutableIntIntMap toImmutable()
      Description copied from interface: IntIntMap
      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 IntIntMap
      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: IntIntMap
      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 IntIntMap
      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

    • equals

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

    • hashCode

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

    • toString

      public String toString()
      Description copied from interface: IntIntMap
      Follows the same general contract as AbstractMap.toString()
      Specified by:
      toString in interface IntIntMap
      Specified by:
      toString in interface PrimitiveIterable
      Overrides:
      toString in class Object
      Returns:
      a string representation of this IntIntMap
      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, ObjectIntToObjectFunction<? super T,​? extends T> function)
      Specified by:
      injectInto in interface IntIterable

    • chunk

      public RichIterable<IntIterable> chunk​(int size)
      Description copied from interface: IntIterable
      Partitions elements in fixed size chunks.
      Specified by:
      chunk in interface IntIterable
      Parameters:
      size - the number of elements per chunk
      Returns:
      A RichIterable containing IntIterables of size size, except the last will be truncated if the elements don't divide evenly.