Package org.eclipse.collections.api.map.primitive

Interface MutableObjectByteMap<K>

All Superinterfaces:
ByteIterable, ObjectByteMap<K>, PrimitiveIterable
All Known Implementing Classes:
ObjectByteHashMap, ObjectByteHashMapWithHashingStrategy, SynchronizedObjectByteMap, UnmodifiableObjectByteMap
public interface MutableObjectByteMap<K>
extends ObjectByteMap<K>
This file was automatically generated from template file mutableObjectPrimitiveMap.stg.
Since:
3.0.

  • Method Details

    • byteIterator

      MutableByteIterator byteIterator()
      Description copied from interface: ByteIterable
      Returns a primitive iterator that can be used to iterate over the ByteIterable in an imperative style.
      Specified by:
      byteIterator in interface ByteIterable

    • clear

      void clear()
      Removes all entries from this map.

    • put

      void put​(K key, byte value)
      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.
      Parameters:
      key - the key
      value - the value to associate with value

    • putPair

      default void putPair​(ObjectBytePair<K> keyValuePair)
      This method allows MutableObjectByteMap the ability to add an element in the form of ObjectBytePair<K>.
      Since:
      9.1.0
      See Also:
      put(Object, byte)

    • putAll

      void putAll​(ObjectByteMap<? extends K> map)
      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.
      Parameters:
      map - the map to copy into this map

    • updateValues

      void updateValues​(ObjectByteToByteFunction<? super K> function)
      Updates the values in-place.
      Parameters:
      function - that takes a key and its value and that returns a new value for this key
      Since:
      10.0

    • removeKey

      void removeKey​(K key)
      Removes the mapping associated with the key, if one exists, from the map.
      Parameters:
      key - the key to remove
      See Also:
      remove(Object)

    • remove

      void remove​(Object key)
      Removes the mapping associated with the key, if one exists, from the map.
      Parameters:
      key - the key to remove
      See Also:
      #removeKey(K)

    • removeKeyIfAbsent

      byte removeKeyIfAbsent​(K key, byte value)
      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.
      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

      byte getIfAbsentPut​(K key, byte value)
      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
      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

      byte getIfAbsentPut​(K key, ByteFunction0 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.
      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

      byte getIfAbsentPutWithKey​(K key, ByteFunction<? super K> 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.
      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

      <P> byte getIfAbsentPutWith​(K key, ByteFunction<? 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.
      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

      byte updateValue​(K key, byte initialValueIfAbsent, ByteToByteFunction 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.
      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

    • flipUniqueValues

      MutableByteObjectMap<K> flipUniqueValues()
      Description copied from interface: ObjectByteMap
      Return the ByteObjectMap that is obtained by flipping the direction of this map and making the associations from value to key.
      Specified by:
      flipUniqueValues in interface ObjectByteMap<K>

    • select

      MutableObjectByteMap<K> select​(ObjectBytePredicate<? super K> predicate)
      Description copied from interface: ObjectByteMap
      Return a copy of this map containing only the key/value pairs that match the predicate.
      Specified by:
      select in interface ObjectByteMap<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

      MutableObjectByteMap<K> reject​(ObjectBytePredicate<? super K> predicate)
      Description copied from interface: ObjectByteMap
      Return a copy of this map containing only the key/value pairs that do not match the predicate.
      Specified by:
      reject in interface ObjectByteMap<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

    • select

      MutableByteCollection select​(BytePredicate predicate)
      Description copied from interface: ByteIterable
      Returns a new ByteIterable with all of the elements in the ByteIterable that return true for the specified predicate.
      Specified by:
      select in interface ByteIterable

    • reject

      MutableByteCollection reject​(BytePredicate predicate)
      Description copied from interface: ByteIterable
      Returns a new ByteIterable with all of the elements in the ByteIterable that return false for the specified predicate.
      Specified by:
      reject in interface ByteIterable

    • tap

      default MutableObjectByteMap<K> tap​(ByteProcedure procedure)
      Specified by:
      tap in interface ByteIterable
      Specified by:
      tap in interface ObjectByteMap<K>
      Since:
      9.0.

    • collect

      <V> MutableCollection<V> collect​(ByteToObjectFunction<? extends V> function)
      Description copied from interface: ByteIterable
      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 ByteIterable

    • withKeyValue

      MutableObjectByteMap<K> withKeyValue​(K key, byte value)
      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.
      Parameters:
      key - the key
      value - the value to associate with value
      Returns:
      this map
      See Also:
      #put(K, byte)

    • withoutKey

      MutableObjectByteMap<K> withoutKey​(K key)
      Removes the mapping associated with the key, if one exists, from this map.
      Parameters:
      key - the key to remove
      Returns:
      this map
      See Also:
      remove(Object)

    • withoutAllKeys

      MutableObjectByteMap<K> withoutAllKeys​(Iterable<? extends K> keys)
      Removes the mappings associated with all the keys, if they exist, from this map.
      Parameters:
      keys - the keys to remove
      Returns:
      this map
      See Also:
      remove(Object)

    • withAllKeyValues

      default MutableObjectByteMap<K> withAllKeyValues​(Iterable<ObjectBytePair<K>> keyValuePairs)

    • asUnmodifiable

      MutableObjectByteMap<K> asUnmodifiable()

    • asSynchronized

      MutableObjectByteMap<K> asSynchronized()

    • addToValue

      byte addToValue​(K key, byte toBeAdded)