Class ImmutableObjectIntHashMap<K>

java.lang.Object
org.eclipse.collections.impl.map.immutable.primitive.AbstractImmutableObjectIntMap<K>
org.eclipse.collections.impl.map.immutable.primitive.ImmutableObjectIntHashMap<K>
All Implemented Interfaces:
Serializable, IntIterable, ImmutableObjectIntMap<K>, ObjectIntMap<K>, PrimitiveIterable
final class ImmutableObjectIntHashMap<K> extends AbstractImmutableObjectIntMap<K> implements Serializable
ImmutableObjectIntHashMap is the non-modifiable equivalent of ObjectIntHashMap. This file was automatically generated from template file immutableObjectPrimitiveHashMap.stg.
Since:
4.0.

  • Field Details

  • Constructor Details

    • ImmutableObjectIntHashMap

      ImmutableObjectIntHashMap(ObjectIntMap<? extends K> delegate)

  • Method Details

    • intIterator

      public IntIterator 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

    • 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 ImmutableIntCollection 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 ImmutableObjectIntMap<K>
      Specified by:
      select in interface IntIterable

    • reject

      public ImmutableIntCollection 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 ImmutableObjectIntMap<K>
      Specified by:
      reject in interface IntIterable

    • detectIfNone

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

    • 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.

    • collect

      public <V> ImmutableCollection<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 ImmutableObjectIntMap<K>
      Specified by:
      collect 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

    • 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 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 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

    • newWithKeyValue

      public ImmutableObjectIntMap<K> newWithKeyValue(K key, int value)
      Description copied from interface: ImmutableObjectIntMap
      Copy this map, associate the value with the key (replacing the value if one already exists for key), and return the copy as new immutable map. A copy is always made even if key is already associated with value.
      Specified by:
      newWithKeyValue in interface ImmutableObjectIntMap<K>
      Parameters:
      key - the key to add
      value - the value to associate with the key in the copy
      Returns:
      an immutable copy of this map with value associated with key

    • newWithoutKey

      public ImmutableObjectIntMap<K> newWithoutKey(K key)
      Description copied from interface: ImmutableObjectIntMap
      Copy this map, remove any associated value with the key (if one exists), and return the copy as a new immutable map.
      Specified by:
      newWithoutKey in interface ImmutableObjectIntMap<K>
      Parameters:
      key - the key to remove
      Returns:
      an immutable copy of this map with key removed

    • newWithoutAllKeys

      public ImmutableObjectIntMap<K> newWithoutAllKeys(Iterable<? extends K> keys)
      Description copied from interface: ImmutableObjectIntMap
      Copy this map, remove any associated values with the specified keys (if any exist), and return the copy as a new immutable map.
      Specified by:
      newWithoutAllKeys in interface ImmutableObjectIntMap<K>
      Parameters:
      keys - the keys to remove
      Returns:
      an immutable copy of this map with all keys in keys removed

    • get

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

    • getOrThrow

      public int getOrThrow(Object key)
      Description copied from interface: ObjectIntMap
      Retrieves the value associated with the key, throwing an IllegalStateException if no such mapping exists.
      Specified by:
      getOrThrow in interface ObjectIntMap<K>
      Parameters:
      key - the key
      Returns:
      the value associated with the key

    • getIfAbsent

      public int getIfAbsent(Object key, int ifAbsent)
      Description copied from interface: ObjectIntMap
      Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
      Specified by:
      getIfAbsent in interface ObjectIntMap<K>
      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

      public boolean containsKey(Object key)
      Description copied from interface: ObjectIntMap
      Returns whether or not the key is present in the map.
      Specified by:
      containsKey in interface ObjectIntMap<K>
      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: ObjectIntMap
      Returns whether or not this map contains the value.
      Specified by:
      containsValue in interface ObjectIntMap<K>
      Parameters:
      value - the value to test
      Returns:
      if this collection contains the value

    • forEachValue

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

    • forEachKey

      public void forEachKey(Procedure<? super K> procedure)
      Description copied from interface: ObjectIntMap
      Iterates through each key in the map, invoking the procedure for each.
      Specified by:
      forEachKey in interface ObjectIntMap<K>
      Parameters:
      procedure - the procedure to invoke for each key

    • forEachKeyValue

      public void forEachKeyValue(ObjectIntProcedure<? super K> objectIntProcedure)
      Description copied from interface: ObjectIntMap
      Iterates through each key/value pair in the map, invoking the procedure for each.
      Specified by:
      forEachKeyValue in interface ObjectIntMap<K>
      Parameters:
      objectIntProcedure - the procedure to invoke for each key/value pair

    • allSatisfyKeyValue

      public boolean allSatisfyKeyValue(ObjectIntPredicate<K> predicate)
      Specified by:
      allSatisfyKeyValue in interface ObjectIntMap<K>
      Since:
      12.0

    • select

      public ImmutableObjectIntMap<K> select(ObjectIntPredicate<? super K> objectIntPredicate)
      Description copied from interface: ObjectIntMap
      Return a copy of this map containing only the key/value pairs that match the predicate.
      Specified by:
      select in interface ImmutableObjectIntMap<K>
      Specified by:
      select in interface ObjectIntMap<K>
      Parameters:
      objectIntPredicate - 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 ImmutableObjectIntMap<K> reject(ObjectIntPredicate<? super K> objectIntPredicate)
      Description copied from interface: ObjectIntMap
      Return a copy of this map containing only the key/value pairs that do not match the predicate.
      Specified by:
      reject in interface ImmutableObjectIntMap<K>
      Specified by:
      reject in interface ObjectIntMap<K>
      Parameters:
      objectIntPredicate - 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

    • toImmutable

      public ImmutableObjectIntMap<K> toImmutable()
      Description copied from interface: ObjectIntMap
      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 ObjectIntMap<K>
      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 Set<K> keySet()
      Description copied from interface: ObjectIntMap
      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 ObjectIntMap<K>
      Returns:
      a mutable set containing the keys in this map

    • values

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

    • keysView

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

    • keyValuesView

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

    • flipUniqueValues

      public ImmutableIntObjectMap<K> flipUniqueValues()
      Description copied from interface: ObjectIntMap
      Return the IntObjectMap that is obtained by flipping the direction of this map and making the associations from value to key.
      Specified by:
      flipUniqueValues in interface ImmutableObjectIntMap<K>
      Specified by:
      flipUniqueValues in interface ObjectIntMap<K>

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Description copied from interface: ObjectIntMap
      Follows the same general contract as AbstractMap.toString()
      Specified by:
      toString in interface ObjectIntMap<K>
      Specified by:
      toString in interface PrimitiveIterable
      Overrides:
      toString in class Object
      Returns:
      a string representation of this ObjectIntMap
      See Also:

    • 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

    • writeReplace

      private Object writeReplace()