Interface Object2ByteMap<K>

All Superinterfaces:
it.unimi.dsi.fastutil.Function<K,Byte>, Function<K,Byte>, Map<K,Byte>, it.unimi.dsi.fastutil.objects.Object2ByteFunction<K>, ToIntFunction<K>
All Known Subinterfaces:
Object2ByteSortedMap<K>
All Known Implementing Classes:
AbstractObject2ByteMap, AbstractObject2ByteSortedMap, Object2ByteArrayMap, Object2ByteAVLTreeMap, Object2ByteLinkedOpenCustomHashMap, Object2ByteLinkedOpenHashMap, Object2ByteMaps.EmptyMap, Object2ByteMaps.Singleton, Object2ByteMaps.SynchronizedMap, Object2ByteMaps.UnmodifiableMap, Object2ByteOpenCustomHashMap, Object2ByteOpenHashMap, Object2ByteRBTreeMap, Object2ByteSortedMaps.EmptySortedMap, Object2ByteSortedMaps.Singleton, Object2ByteSortedMaps.SynchronizedSortedMap, Object2ByteSortedMaps.UnmodifiableSortedMap

public interface Object2ByteMap<K> extends it.unimi.dsi.fastutil.objects.Object2ByteFunction<K>, Map<K,Byte>
A type-specific Map; provides some additional methods that use polymorphism to avoid (un)boxing, and handling of a default return value.

Besides extending the corresponding type-specific function, this interface strengthens Map.entrySet(), keySet() and values(). Moreover, a number of methods, such as size(), defaultReturnValue(), etc., are un-defaulted as their function default do not make sense for a map. Maps returning entry sets of type Object2ByteMap.FastEntrySet support also fast iteration.

A submap or subset may or may not have an independent default return value (which however must be initialized to the default return value of the originator).

See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    A type-specific Map.Entry; provides some additional methods that use polymorphism to avoid (un)boxing.
    static interface 
    An entry set providing fast iteration.
  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    Removes all of the mappings from this map (optional operation).
    default byte
    computeByte(K key, BiFunction<? super K,? super Byte,? extends Byte> remappingFunction)
    Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping).
    default byte
    computeByteIfAbsent(K key, ToIntFunction<? super K> mappingFunction)
    Deprecated.
    Please use computeIfAbsent() instead.
    default byte
    computeByteIfAbsentPartial(K key, it.unimi.dsi.fastutil.objects.Object2ByteFunction<? super K> mappingFunction)
    Deprecated.
    Please use computeIfAbsent() instead.
    default byte
    computeByteIfPresent(K key, BiFunction<? super K,? super Byte,? extends Byte> remappingFunction)
    If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.
    default byte
    computeIfAbsent(K key, it.unimi.dsi.fastutil.objects.Object2ByteFunction<? super K> mappingFunction)
    If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map, unless the key is not present in the given mapping function.
    default byte
    computeIfAbsent(K key, ToIntFunction<? super K> mappingFunction)
    If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map.
    boolean
    Returns true if this function contains a mapping for the specified key.
    boolean
    containsValue(byte value)
    Returns true if this map maps one or more keys to the specified value.
    default boolean
    Deprecated.
    Please use the corresponding type-specific method instead.
    byte
    Gets the default return value.
    void
    Sets the default return value (optional operation).
    static <K> Object2ByteMap.Entry<K>
    entry(K key, byte value)
    Returns an unmodifiable, type-specific entry.
    default it.unimi.dsi.fastutil.objects.ObjectSet<Map.Entry<K,Byte>>
    Deprecated.
    Please use the corresponding type-specific method instead.
    default void
    forEach(it.unimi.dsi.fastutil.objects.ObjectByteBiConsumer<? super K> consumer)
    Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.
    default void
    forEach(BiConsumer<? super K,? super Byte> action)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default Byte
    get(Object key)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default byte
    getOrDefault(Object key, byte defaultValue)
    Returns the value to which the specified key is mapped, or the defaultValue if this map contains no mapping for the key.
    default Byte
    getOrDefault(Object key, Byte defaultValue)
    Deprecated.
    Please use the corresponding type-specific method instead.
    it.unimi.dsi.fastutil.objects.ObjectSet<K>
    default byte
    merge(K key, byte value, BiFunction<? super Byte,? super Byte,? extends Byte> remappingFunction)
    If the specified key is not already associated with a value, associates it with the given value.
    default Byte
    merge(K key, Byte value, BiFunction<? super Byte,? super Byte,? extends Byte> remappingFunction)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default byte
    mergeByte(K key, byte value, it.unimi.dsi.fastutil.bytes.ByteBinaryOperator remappingFunction)
    If the specified key is not already associated with a value, associates it with the given value.
    default byte
    mergeByte(K key, byte value, BiFunction<? super Byte,? super Byte,? extends Byte> remappingFunction)
    Deprecated.
    Please use merge() instead.
    default byte
    mergeByte(K key, byte value, IntBinaryOperator remappingFunction)
    If the specified key is not already associated with a value, associates it with the given value.
    it.unimi.dsi.fastutil.objects.ObjectSet<Object2ByteMap.Entry<K>>
    Returns a type-specific set view of the mappings contained in this map.
    static <K> Object2ByteMap<K>
    Returns an unmodifiable, type-specific map with the specified entries.
    default Byte
    put(K key, Byte value)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default byte
    putIfAbsent(K key, byte value)
    If the specified key is not already associated with a value, associates it with the given value and returns the default return value, else returns the current value.
    default Byte
    putIfAbsent(K key, Byte value)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default Byte
    Deprecated.
    Please use the corresponding type-specific method instead.
    default boolean
    remove(Object key, byte value)
    Removes the entry for the specified key only if it is currently mapped to the specified value.
    default boolean
    remove(Object key, Object value)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default byte
    replace(K key, byte value)
    Replaces the entry for the specified key only if it is currently mapped to some value.
    default boolean
    replace(K key, byte oldValue, byte newValue)
    Replaces the entry for the specified key only if currently mapped to the specified value.
    default Byte
    replace(K key, Byte value)
    Deprecated.
    Please use the corresponding type-specific method instead.
    default boolean
    replace(K key, Byte oldValue, Byte newValue)
    Deprecated.
    Please use the corresponding type-specific method instead.
    int
    Returns the number of key/value mappings in this map.
    it.unimi.dsi.fastutil.bytes.ByteCollection

    Methods inherited from interface it.unimi.dsi.fastutil.Function

    apply

    Methods inherited from interface java.util.function.Function

    compose

    Methods inherited from interface java.util.Map

    compute, computeIfAbsent, computeIfPresent, equals, hashCode, isEmpty, putAll, replaceAll

    Methods inherited from interface it.unimi.dsi.fastutil.objects.Object2ByteFunction

    andThen, andThenByte, andThenChar, andThenDouble, andThenFloat, andThenInt, andThenLong, andThenObject, andThenReference, andThenShort, applyAsInt, composeByte, composeChar, composeDouble, composeFloat, composeInt, composeLong, composeObject, composeReference, composeShort, getByte, put, removeByte
  • Method Details

    • size

      int size()
      Returns the number of key/value mappings in this map. If the map contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
      Specified by:
      size in interface it.unimi.dsi.fastutil.Function<K,Byte>
      Specified by:
      size in interface Map<K,Byte>
      Returns:
      the number of key-value mappings in this map.
      See Also:
      • Size64
    • clear

      default void clear()
      Removes all of the mappings from this map (optional operation). The map will be empty after this call returns.
      Specified by:
      clear in interface it.unimi.dsi.fastutil.Function<K,Byte>
      Specified by:
      clear in interface Map<K,Byte>
      Throws:
      UnsupportedOperationException - if the clear() operation is not supported by this map
    • defaultReturnValue

      void defaultReturnValue(byte rv)
      Sets the default return value (optional operation). This value must be returned by type-specific versions of get(), put() and remove() to denote that the map does not contain the specified key. It must be 0/false by default.
      Specified by:
      defaultReturnValue in interface it.unimi.dsi.fastutil.objects.Object2ByteFunction<K>
      Parameters:
      rv - the new default return value.
      See Also:
    • defaultReturnValue

      byte defaultReturnValue()
      Gets the default return value.
      Specified by:
      defaultReturnValue in interface it.unimi.dsi.fastutil.objects.Object2ByteFunction<K>
      Returns:
      the current default return value.
    • object2ByteEntrySet

      it.unimi.dsi.fastutil.objects.ObjectSet<Object2ByteMap.Entry<K>> object2ByteEntrySet()
      Returns a type-specific set view of the mappings contained in this map.

      This method is necessary because there is no inheritance along type parameters: it is thus impossible to strengthen Map.entrySet() so that it returns an ObjectSet of type-specific entries (the latter makes it possible to access keys and values with type-specific methods).

      Returns:
      a type-specific set view of the mappings contained in this map.
      See Also:
    • entrySet

      @Deprecated default it.unimi.dsi.fastutil.objects.ObjectSet<Map.Entry<K,Byte>> entrySet()
      Deprecated.
      Please use the corresponding type-specific method instead.
      Returns a set view of the mappings contained in this map.
      Specified by:
      entrySet in interface Map<K,Byte>
      Returns:
      a set view of the mappings contained in this map.
      See Also:
    • put

      @Deprecated default Byte put(K key, Byte value)
      Deprecated.
      Please use the corresponding type-specific method instead.

      This default implementation just delegates to the corresponding type-specific–function method.

      Specified by:
      put in interface it.unimi.dsi.fastutil.Function<K,Byte>
      Specified by:
      put in interface Map<K,Byte>
      Specified by:
      put in interface it.unimi.dsi.fastutil.objects.Object2ByteFunction<K>
    • get

      @Deprecated default Byte get(Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.

      This default implementation just delegates to the corresponding type-specific–function method.

      Specified by:
      get in interface it.unimi.dsi.fastutil.Function<K,Byte>
      Specified by:
      get in interface Map<K,Byte>
      Specified by:
      get in interface it.unimi.dsi.fastutil.objects.Object2ByteFunction<K>
    • remove

      @Deprecated default Byte remove(Object key)
      Deprecated.
      Please use the corresponding type-specific method instead.

      This default implementation just delegates to the corresponding type-specific–function method.

      Specified by:
      remove in interface it.unimi.dsi.fastutil.Function<K,Byte>
      Specified by:
      remove in interface Map<K,Byte>
      Specified by:
      remove in interface it.unimi.dsi.fastutil.objects.Object2ByteFunction<K>
    • keySet

      it.unimi.dsi.fastutil.objects.ObjectSet<K> keySet()
      Specified by:
      keySet in interface Map<K,Byte>
      Returns:
      a set view of the keys contained in this map.
      See Also:
    • values

      it.unimi.dsi.fastutil.bytes.ByteCollection values()
      Specified by:
      values in interface Map<K,Byte>
      Returns:
      a set view of the values contained in this map.
      See Also:
    • containsKey

      boolean containsKey(Object key)
      Returns true if this function contains a mapping for the specified key.
      Specified by:
      containsKey in interface it.unimi.dsi.fastutil.Function<K,Byte>
      Specified by:
      containsKey in interface Map<K,Byte>
      Parameters:
      key - the key.
      Returns:
      true if this function associates a value to key.
      See Also:
    • containsValue

      boolean containsValue(byte value)
      Returns true if this map maps one or more keys to the specified value.
      See Also:
    • containsValue

      @Deprecated default boolean containsValue(Object value)
      Deprecated.
      Please use the corresponding type-specific method instead.
      Specified by:
      containsValue in interface Map<K,Byte>
    • forEach

      default void forEach(it.unimi.dsi.fastutil.objects.ObjectByteBiConsumer<? super K> consumer)
      Performs the given action for each entry in this map until all entries have been processed or the action throws an exception.

      This default implementation just delegates to forEach on the type-specific entry set, taking care of using fastForEach if available.

      See Also:
    • forEach

      @Deprecated default void forEach(BiConsumer<? super K,? super Byte> action)
      Deprecated.
      Please use the corresponding type-specific method instead.

      This default implementation just delegates to the corresponding Map method.

      Specified by:
      forEach in interface Map<K,Byte>
    • getOrDefault

      default byte getOrDefault(Object key, byte defaultValue)
      Returns the value to which the specified key is mapped, or the defaultValue if this map contains no mapping for the key.
      Specified by:
      getOrDefault in interface it.unimi.dsi.fastutil.objects.Object2ByteFunction<K>
      Parameters:
      key - the key.
      defaultValue - the default mapping of the key.
      Returns:
      the value to which the specified key is mapped, or the defaultValue if this map contains no mapping for the key.
      Since:
      8.0.0
      See Also:
    • getOrDefault

      @Deprecated default Byte getOrDefault(Object key, Byte defaultValue)
      Deprecated.
      Please use the corresponding type-specific method instead.

      This default implementation just delegates to the corresponding Map method.

      Specified by:
      getOrDefault in interface it.unimi.dsi.fastutil.Function<K,Byte>
      Specified by:
      getOrDefault in interface Map<K,Byte>
      Specified by:
      getOrDefault in interface it.unimi.dsi.fastutil.objects.Object2ByteFunction<K>
    • putIfAbsent

      default byte putIfAbsent(K key, byte value)
      If the specified key is not already associated with a value, associates it with the given value and returns the default return value, else returns the current value.
      Parameters:
      key - key with which the specified value is to be associated.
      value - value to be associated with the specified key.
      Returns:
      the previous value associated with the specified key, or the default return value if there was no mapping for the key.
      Since:
      8.0.0
      See Also:
    • remove

      default boolean remove(Object key, byte value)
      Removes the entry for the specified key only if it is currently mapped to the specified value.
      Parameters:
      key - key with which the specified value is associated.
      value - value expected to be associated with the specified key.
      Returns:
      true if the value was removed.
      Since:
      8.0.0
      See Also:
    • replace

      default boolean replace(K key, byte oldValue, byte newValue)
      Replaces the entry for the specified key only if currently mapped to the specified value.
      Parameters:
      key - key with which the specified value is associated.
      oldValue - value expected to be associated with the specified key.
      newValue - value to be associated with the specified key.
      Returns:
      true if the value was replaced.
      Since:
      8.0.0
      See Also:
    • replace

      default byte replace(K key, byte value)
      Replaces the entry for the specified key only if it is currently mapped to some value.
      Parameters:
      key - key with which the specified value is associated.
      value - value to be associated with the specified key.
      Returns:
      the previous value associated with the specified key, or the default return value if there was no mapping for the key.
      Since:
      8.0.0
      See Also:
    • computeIfAbsent

      default byte computeIfAbsent(K key, ToIntFunction<? super K> mappingFunction)
      If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map.

      Note that contrarily to the default computeIfAbsent(), it is not possible to not add a value for a given key, since the mappingFunction cannot return null. If such a behavior is needed, please use the corresponding nullable version.

      Parameters:
      key - key with which the specified value is to be associated.
      mappingFunction - the function to compute a value.
      Returns:
      the current (existing or computed) value associated with the specified key.
      Since:
      8.0.0
      See Also:
    • computeByteIfAbsent

      @Deprecated default byte computeByteIfAbsent(K key, ToIntFunction<? super K> mappingFunction)
      Deprecated.
      Please use computeIfAbsent() instead.
    • computeIfAbsent

      default byte computeIfAbsent(K key, it.unimi.dsi.fastutil.objects.Object2ByteFunction<? super K> mappingFunction)
      If the specified key is not already associated with a value, attempts to compute its value using the given mapping function and enters it into this map, unless the key is not present in the given mapping function.

      This version of computeIfAbsent() uses a type-specific version of fastutil's Function. Since Function has a containsKey() method, it is possible to avoid adding a key by having containsKey() return false for that key.

      Parameters:
      key - key with which the specified value is to be associated.
      mappingFunction - the function to compute a value.
      Returns:
      the current (existing or computed) value associated with the specified key.
      Since:
      8.0.0
      See Also:
    • computeByteIfAbsentPartial

      @Deprecated default byte computeByteIfAbsentPartial(K key, it.unimi.dsi.fastutil.objects.Object2ByteFunction<? super K> mappingFunction)
      Deprecated.
      Please use computeIfAbsent() instead.
    • computeByteIfPresent

      default byte computeByteIfPresent(K key, BiFunction<? super K,? super Byte,? extends Byte> remappingFunction)
      If the value for the specified key is present, attempts to compute a new mapping given the key and its current mapped value.
      Parameters:
      key - key with which the specified value is to be associated.
      remappingFunction - the function to compute a value.
      Returns:
      the new value associated with the specified key, or the default return value if none.
      Since:
      8.0.0
      See Also:
    • computeByte

      default byte computeByte(K key, BiFunction<? super K,? super Byte,? extends Byte> remappingFunction)
      Attempts to compute a mapping for the specified key and its current mapped value (or null if there is no current mapping).

      If the function returns null, the mapping is removed (or remains absent if initially absent). If the function itself throws an (unchecked) exception, the exception is rethrown, and the current mapping is left unchanged.

      Parameters:
      key - key with which the specified value is to be associated.
      remappingFunction - the function to compute a value.
      Returns:
      the new value associated with the specified key, or the default return value if none.
      Since:
      8.0.0
      See Also:
    • merge

      default byte merge(K key, byte value, BiFunction<? super Byte,? super Byte,? extends Byte> remappingFunction)
      If the specified key is not already associated with a value, associates it with the given value. Otherwise, replaces the associated value with the results of the given remapping function, or removes if the result is null.
      Parameters:
      key - key with which the resulting value is to be associated.
      value - the value to be merged with the existing value associated with the key or, if no existing value is associated with the key, to be associated with the key.
      remappingFunction - the function to recompute a value if present.
      Returns:
      the new value associated with the specified key, or the default return value if no value is associated with the key.
      Since:
      8.0.0
      See Also:
    • mergeByte

      default byte mergeByte(K key, byte value, it.unimi.dsi.fastutil.bytes.ByteBinaryOperator remappingFunction)
      If the specified key is not already associated with a value, associates it with the given value. Otherwise, replaces the associated value with the results of the given remapping function.
      Parameters:
      key - key with which the resulting value is to be associated.
      value - the value to be merged with the existing value associated with the key or, if no existing value is associated with the key, to be associated with the key.
      remappingFunction - the function to recompute a value if present.
      Returns:
      the new value associated with the specified key.
      Since:
      8.5.0
      See Also:
    • mergeByte

      default byte mergeByte(K key, byte value, IntBinaryOperator remappingFunction)
      If the specified key is not already associated with a value, associates it with the given value. Otherwise, replaces the associated value with the results of the given remapping function.
      Parameters:
      key - key with which the resulting value is to be associated.
      value - the value to be merged with the existing value associated with the key or, if no existing value is associated with the key, to be associated with the key.
      remappingFunction - the function to recompute a value if present.
      Returns:
      the new value associated with the specified key.
      Since:
      8.5.0
      See Also:
    • mergeByte

      @Deprecated default byte mergeByte(K key, byte value, BiFunction<? super Byte,? super Byte,? extends Byte> remappingFunction)
      Deprecated.
      Please use merge() instead.
    • putIfAbsent

      @Deprecated default Byte putIfAbsent(K key, Byte value)
      Deprecated.
      Please use the corresponding type-specific method instead.

      This default implementation just delegates to the corresponding Map method.

      Specified by:
      putIfAbsent in interface Map<K,Byte>
    • remove

      @Deprecated default boolean remove(Object key, Object value)
      Deprecated.
      Please use the corresponding type-specific method instead.

      This default implementation just delegates to the corresponding Map method.

      Specified by:
      remove in interface Map<K,Byte>
    • replace

      @Deprecated default boolean replace(K key, Byte oldValue, Byte newValue)
      Deprecated.
      Please use the corresponding type-specific method instead.

      This default implementation just delegates to the corresponding Map method.

      Specified by:
      replace in interface Map<K,Byte>
    • replace

      @Deprecated default Byte replace(K key, Byte value)
      Deprecated.
      Please use the corresponding type-specific method instead.

      This default implementation just delegates to the corresponding Map method.

      Specified by:
      replace in interface Map<K,Byte>
    • merge

      @Deprecated default Byte merge(K key, Byte value, BiFunction<? super Byte,? super Byte,? extends Byte> remappingFunction)
      Deprecated.
      Please use the corresponding type-specific method instead.

      This default implementation just delegates to the corresponding Map method.

      Specified by:
      merge in interface Map<K,Byte>
    • ofEntries

      @SafeVarargs static <K> Object2ByteMap<K> ofEntries(Object2ByteMap.Entry<K>... entries)
      Returns an unmodifiable, type-specific map with the specified entries. See Map.ofEntries(Map.Entry[])
    • entry

      static <K> Object2ByteMap.Entry<K> entry(K key, byte value)
      Returns an unmodifiable, type-specific entry. See Map.entry(Object, Object)