Class UnmodifiableObjectLongMap<K>

java.lang.Object
org.eclipse.collections.impl.map.mutable.primitive.UnmodifiableObjectLongMap<K>
All Implemented Interfaces:
Serializable, LongIterable, MutableObjectLongMap<K>, ObjectLongMap<K>, PrimitiveIterable

public class UnmodifiableObjectLongMap<K> extends Object implements MutableObjectLongMap<K>, Serializable
This file was automatically generated from template file unmodifiableObjectPrimitiveMap.stg.
Since:
3.2
See Also:
  • Constructor Details

  • Method Details

    • clear

      public void clear()
      Description copied from interface: MutableObjectLongMap
      Removes all entries from this map.
      Specified by:
      clear in interface MutableObjectLongMap<K>
    • put

      public void put(K key, long value)
      Description copied from interface: MutableObjectLongMap
      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 MutableObjectLongMap<K>
      Parameters:
      key - the key
      value - the value to associate with value
    • putPair

      public void putPair(ObjectLongPair<K> keyValuePair)
      Description copied from interface: MutableObjectLongMap
      This method allows MutableObjectLongMap the ability to add an element in the form of ObjectLongPair<K>.
      Specified by:
      putPair in interface MutableObjectLongMap<K>
      See Also:
    • putAll

      public void putAll(ObjectLongMap<? extends K> map)
      Description copied from interface: MutableObjectLongMap
      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 MutableObjectLongMap<K>
      Parameters:
      map - the map to copy into this map
    • updateValues

      public void updateValues(ObjectLongToLongFunction<? super K> function)
      Description copied from interface: MutableObjectLongMap
      Updates the values in-place.
      Specified by:
      updateValues in interface MutableObjectLongMap<K>
      Parameters:
      function - that takes a key and its value and that returns a new value for this key
    • removeKey

      public void removeKey(K key)
      Description copied from interface: MutableObjectLongMap
      Removes the mapping associated with the key, if one exists, from the map.
      Specified by:
      removeKey in interface MutableObjectLongMap<K>
      Parameters:
      key - the key to remove
      See Also:
    • remove

      public void remove(Object key)
      Description copied from interface: MutableObjectLongMap
      Removes the mapping associated with the key, if one exists, from the map.
      Specified by:
      remove in interface MutableObjectLongMap<K>
      Parameters:
      key - the key to remove
      See Also:
    • removeKeyIfAbsent

      public long removeKeyIfAbsent(K key, long value)
      Description copied from interface: MutableObjectLongMap
      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 MutableObjectLongMap<K>
      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 long getIfAbsentPut(K key, long value)
      Description copied from interface: MutableObjectLongMap
      Retrieves the value associated with the key if one exists; if it does not, associates a value with the key. a new value with they key
      Specified by:
      getIfAbsentPut in interface MutableObjectLongMap<K>
      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 long getIfAbsentPut(K key, LongFunction0 function)
      Description copied from interface: MutableObjectLongMap
      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 MutableObjectLongMap<K>
      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 long getIfAbsentPutWithKey(K key, LongFunction<? super K> function)
      Description copied from interface: MutableObjectLongMap
      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 MutableObjectLongMap<K>
      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> long getIfAbsentPutWith(K key, LongFunction<? super P> function, P parameter)
      Description copied from interface: MutableObjectLongMap
      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 MutableObjectLongMap<K>
      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 long updateValue(K key, long initialValueIfAbsent, LongToLongFunction function)
      Description copied from interface: MutableObjectLongMap
      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 MutableObjectLongMap<K>
      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
    • addToValue

      public long addToValue(K key, long toBeAdded)
      Specified by:
      addToValue in interface MutableObjectLongMap<K>
    • get

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

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

      public long getIfAbsent(Object key, long ifAbsent)
      Description copied from interface: ObjectLongMap
      Retrieves the value associated with the key, returning the specified default value if no such mapping exists.
      Specified by:
      getIfAbsent in interface ObjectLongMap<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: ObjectLongMap
      Returns whether or not the key is present in the map.
      Specified by:
      containsKey in interface ObjectLongMap<K>
      Parameters:
      key - the key
      Returns:
      if a mapping exists in this map for the key
    • containsValue

      public boolean containsValue(long value)
      Description copied from interface: ObjectLongMap
      Returns whether or not this map contains the value.
      Specified by:
      containsValue in interface ObjectLongMap<K>
      Parameters:
      value - the value to test
      Returns:
      if this collection contains the value
    • forEachValue

      public void forEachValue(LongProcedure procedure)
      Description copied from interface: ObjectLongMap
      Iterates through each value in this map.
      Specified by:
      forEachValue in interface ObjectLongMap<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: ObjectLongMap
      Iterates through each key in the map, invoking the procedure for each.
      Specified by:
      forEachKey in interface ObjectLongMap<K>
      Parameters:
      procedure - the procedure to invoke for each key
    • forEachKeyValue

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

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

      public MutableLongIterator longIterator()
      Description copied from interface: LongIterable
      Returns a primitive iterator that can be used to iterate over the LongIterable in an imperative style.
      Specified by:
      longIterator in interface LongIterable
      Specified by:
      longIterator in interface MutableObjectLongMap<K>
    • forEach

      public void forEach(LongProcedure procedure)
      Description copied from interface: LongIterable
      Applies the LongProcedure to each element in the LongIterable.
      Specified by:
      forEach in interface LongIterable
    • each

      public void each(LongProcedure procedure)
      Description copied from interface: LongIterable
      A synonym for forEach.
      Specified by:
      each in interface LongIterable
      Since:
      7.0.
    • count

      public int count(LongPredicate predicate)
      Description copied from interface: LongIterable
      Returns a count of the number of elements in the LongIterable that return true for the specified predicate.
      Specified by:
      count in interface LongIterable
    • anySatisfy

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

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

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

      public MutableLongCollection select(LongPredicate predicate)
      Description copied from interface: LongIterable
      Returns a new LongIterable with all of the elements in the LongIterable that return true for the specified predicate.
      Specified by:
      select in interface LongIterable
      Specified by:
      select in interface MutableObjectLongMap<K>
    • reject

      public MutableLongCollection reject(LongPredicate predicate)
      Description copied from interface: LongIterable
      Returns a new LongIterable with all of the elements in the LongIterable that return false for the specified predicate.
      Specified by:
      reject in interface LongIterable
      Specified by:
      reject in interface MutableObjectLongMap<K>
    • detectIfNone

      public long detectIfNone(LongPredicate predicate, long ifNone)
      Specified by:
      detectIfNone in interface LongIterable
    • collect

      public <V1> MutableCollection<V1> collect(LongToObjectFunction<? extends V1> function)
      Description copied from interface: LongIterable
      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 LongIterable
      Specified by:
      collect in interface MutableObjectLongMap<K>
    • sum

      public long sum()
      Specified by:
      sum in interface LongIterable
    • max

      public long max()
      Specified by:
      max in interface LongIterable
    • maxIfEmpty

      public long maxIfEmpty(long defaultValue)
      Specified by:
      maxIfEmpty in interface LongIterable
    • min

      public long min()
      Specified by:
      min in interface LongIterable
    • minIfEmpty

      public long minIfEmpty(long defaultValue)
      Specified by:
      minIfEmpty in interface LongIterable
    • average

      public double average()
      Specified by:
      average in interface LongIterable
    • median

      public double median()
      Specified by:
      median in interface LongIterable
    • toSortedArray

      public long[] toSortedArray()
      Specified by:
      toSortedArray in interface LongIterable
    • toSortedList

      public MutableLongList toSortedList()
      Specified by:
      toSortedList in interface LongIterable
    • toArray

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

      public long[] toArray(long[] target)
      Description copied from interface: LongIterable
      Converts the LongIterable to a primitive long 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 LongIterable
    • contains

      public boolean contains(long value)
      Description copied from interface: LongIterable
      Returns true if the value is contained in the LongIterable, and false if it is not.
      Specified by:
      contains in interface LongIterable
    • containsAll

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

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

      public MutableLongList toList()
      Description copied from interface: LongIterable
      Converts the LongIterable to a new MutableLongList.
      Specified by:
      toList in interface LongIterable
    • toSet

      public MutableLongSet toSet()
      Description copied from interface: LongIterable
      Converts the LongIterable to a new MutableLongSet.
      Specified by:
      toSet in interface LongIterable
    • toBag

      public MutableLongBag toBag()
      Description copied from interface: LongIterable
      Converts the LongIterable to a new MutableLongBag.
      Specified by:
      toBag in interface LongIterable
    • asLazy

      public LazyLongIterable asLazy()
      Description copied from interface: LongIterable
      Returns a LazyLongIterable adapter wrapping the source LongIterable.
      Specified by:
      asLazy in interface LongIterable
    • withKeyValue

      public MutableObjectLongMap<K> withKeyValue(K key, long value)
      Description copied from interface: MutableObjectLongMap
      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 MutableObjectLongMap<K>
      Parameters:
      key - the key
      value - the value to associate with value
      Returns:
      this map
      See Also:
    • withoutKey

      public MutableObjectLongMap<K> withoutKey(K key)
      Description copied from interface: MutableObjectLongMap
      Removes the mapping associated with the key, if one exists, from this map.
      Specified by:
      withoutKey in interface MutableObjectLongMap<K>
      Parameters:
      key - the key to remove
      Returns:
      this map
      See Also:
    • withoutAllKeys

      public MutableObjectLongMap<K> withoutAllKeys(Iterable<? extends K> keys)
      Description copied from interface: MutableObjectLongMap
      Removes the mappings associated with all the keys, if they exist, from this map.
      Specified by:
      withoutAllKeys in interface MutableObjectLongMap<K>
      Parameters:
      keys - the keys to remove
      Returns:
      this map
      See Also:
    • asUnmodifiable

      public MutableObjectLongMap<K> asUnmodifiable()
      Specified by:
      asUnmodifiable in interface MutableObjectLongMap<K>
    • asSynchronized

      public MutableObjectLongMap<K> asSynchronized()
      Specified by:
      asSynchronized in interface MutableObjectLongMap<K>
    • toImmutable

      public ImmutableObjectLongMap<K> toImmutable()
      Description copied from interface: ObjectLongMap
      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 ObjectLongMap<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: ObjectLongMap
      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 ObjectLongMap<K>
      Returns:
      a mutable set containing the keys in this map
    • values

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

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

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

      public MutableLongObjectMap<K> flipUniqueValues()
      Description copied from interface: ObjectLongMap
      Return the LongObjectMap that is obtained by flipping the direction of this map and making the associations from value to key.
      Specified by:
      flipUniqueValues in interface MutableObjectLongMap<K>
      Specified by:
      flipUniqueValues in interface ObjectLongMap<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: ObjectLongMap
      Follows the same general contract as AbstractMap.toString()
      Specified by:
      toString in interface ObjectLongMap<K>
      Specified by:
      toString in interface PrimitiveIterable
      Overrides:
      toString in class Object
      Returns:
      a string representation of this ObjectLongMap
      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
    • injectInto

      public <T> T injectInto(T injectedValue, ObjectLongToObjectFunction<? super T,? extends T> function)
      Specified by:
      injectInto in interface LongIterable
    • chunk

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