Modul speiger.src.collections
Package speiger.src.collections.objects.maps.interfaces

Schnittstelle Object2ShortMap<T>

Typparameter:
T - the keyType of elements maintained by this Collection
Alle Superschnittstellen:
Map<T,Short>, ToShortFunction<T>
Alle bekannten Unterschnittstellen:
Object2ShortConcurrentMap<T>, Object2ShortNavigableMap<T>, Object2ShortOrderedMap<T>, Object2ShortSortedMap<T>
Alle bekannten Implementierungsklassen:
AbstractObject2ShortMap, Enum2ShortMap, ImmutableObject2ShortOpenHashMap, LinkedEnum2ShortMap, Object2ShortArrayMap, Object2ShortAVLTreeMap, Object2ShortConcurrentOpenHashMap, Object2ShortLinkedOpenCustomHashMap, Object2ShortLinkedOpenHashMap, Object2ShortMaps.EmptyMap, Object2ShortMaps.SingletonMap, Object2ShortMaps.SynchronizedMap, Object2ShortMaps.SynchronizedNavigableMap, Object2ShortMaps.SynchronizedOrderedMap, Object2ShortMaps.SynchronizedSortedMap, Object2ShortMaps.UnmodifyableMap, Object2ShortMaps.UnmodifyableNavigableMap, Object2ShortMaps.UnmodifyableOrderedMap, Object2ShortMaps.UnmodifyableSortedMap, Object2ShortOpenCustomHashMap, Object2ShortOpenHashMap, Object2ShortRBTreeMap
public interface Object2ShortMap<T> extends Map<T,Short>, ToShortFunction<T>
A Type Specific Map that reduces memory overhead due to boxing/unboxing of Primitives and some extra helper functions.

  • Methodendetails

    • builder

      static Object2ShortMap.MapBuilder builder()
      Helper Class that allows to create Maps without requiring a to type out the entire implementation or know it.
      Gibt zurück:
      a MapBuilder

    • getDefaultReturnValue

      short getDefaultReturnValue()
      Method to see what the default return value is.
      Gibt zurück:
      default return value

    • setDefaultReturnValue

      Object2ShortMap<T> setDefaultReturnValue(short v)
      Method to define the default return value if a requested key isn't present
      Parameter:
      v - value that should be the default return value
      Gibt zurück:
      itself

    • copy

      Object2ShortMap<T> copy()
      A Function that does a shallow clone of the Map itself. This function is more optimized then a copy constructor since the Map does not have to be unsorted/resorted. It can be compared to Cloneable but with less exception risk
      Gibt zurück:
      a Shallow Copy of the Map
      Note:
      Wrappers and view Maps will not support this feature

    • put

      short put(T key, short value)
      Type Specific method to reduce boxing/unboxing of values
      Parameter:
      key - the key that should be inserted,
      value - the value that should be inserted
      Gibt zurück:
      the last present value or default return value.
      Siehe auch:

    • put

      default short put(Object2ShortMap.Entry<T> entry)
      A Helper method that allows to put int a Object2ShortMap.Entry into a map.
      Parameter:
      entry - then Entry that should be inserted.
      Gibt zurück:
      the last present value or default return value.

    • put

      default Short put(Map.Entry<T,Short> entry)
      A Helper method that allows to put int a Map.Entry into a map.
      Parameter:
      entry - then Entry that should be inserted.
      Gibt zurück:
      the last present value or default return value.

    • putAll

      default void putAll(T[] keys, short[] values)
      Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
      Parameter:
      keys - the keys that should be added
      values - the values that should be added
      Löst aus:
      IllegalStateException - if the arrays are not the same size
      Siehe auch:

    • putAll

      void putAll(T[] keys, short[] values, int offset, int size)
      Type Specific array method to bulk add elements into a map without creating a wrapper and increasing performances
      Parameter:
      keys - the keys that should be added
      values - the values that should be added
      offset - where the to start in the array
      size - how many elements should be added
      Löst aus:
      IllegalStateException - if the arrays are not within the range
      Siehe auch:

    • putAll

      default void putAll(T[] keys, Short[] values)
      Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
      Parameter:
      keys - the keys that should be added
      values - the values that should be added
      Löst aus:
      IllegalStateException - if the arrays are not the same size
      Siehe auch:

    • putAll

      void putAll(T[] keys, Short[] values, int offset, int size)
      Type Specific Object array method to bulk add elements into a map without creating a wrapper and increasing performances
      Parameter:
      keys - the keys that should be added
      values - the values that should be added
      offset - where the to start in the array
      size - how many elements should be added
      Löst aus:
      IllegalStateException - if the arrays are not within the range
      Siehe auch:

    • putIfAbsent

      short putIfAbsent(T key, short value)
      Type Specific method to reduce boxing/unboxing of values
      Parameter:
      key - the key that should be inserted,
      value - the value that should be inserted
      Gibt zurück:
      the last present value or default return value.
      Siehe auch:

    • putAllIfAbsent

      void putAllIfAbsent(Object2ShortMap<T> m)
      Type-Specific bulk put method put elements into the map if not present.
      Parameter:
      m - elements that should be added if not present.

    • addTo

      short addTo(T key, short value)
      A Helper method to add a primitives together. If key is not present then this functions as a put.
      Parameter:
      key - the key that should be inserted,
      value - the value that should be inserted / added
      Gibt zurück:
      the last present value or default return value.

    • addToAll

      void addToAll(Object2ShortMap<T> m)
      A Helper method to bulk add primitives together.
      Parameter:
      m - the values that should be added/inserted

    • subFrom

      short subFrom(T key, short value)
      A Helper method to subtract from primitive from each other. If the key is not present it will just return the defaultValue How the implementation works is that it will subtract from the current value (if not present it will do nothing) and fence it to the getDefaultReturnValue() If the fence is reached the element will be automaticall removed
      Parameter:
      key - that should be subtract from
      value - that should be subtract
      Gibt zurück:
      the last present or default return value

    • putAll

      void putAll(Object2ShortMap<T> m)
      Type Specific function for the bull putting of values
      Parameter:
      m - the elements that should be inserted

    • containsValue

      boolean containsValue(short value)
      Type Specific method to reduce boxing/unboxing of values
      Parameter:
      value - element that is searched for
      Gibt zurück:
      if the value is present

    • containsValue

      default boolean containsValue(Object value)
      Angegeben von:
      containsValue in Schnittstelle Map<T,Short>
      Parameter:
      value - that is searched for.
      Gibt zurück:
      true if found
      Siehe auch:
      Note:
      in some implementations key does not have to be CLASS_VALUE but just have to support equals with CLASS_VALUE.

    • rem

      short rem(T key)
      Type Specific remove function to reduce boxing/unboxing
      Parameter:
      key - the element that should be removed
      Gibt zurück:
      the value that was removed or default return value

    • remove

      default Short remove(Object key)
      Angegeben von:
      remove in Schnittstelle Map<T,Short>
      Parameter:
      key - the element that should be removed
      Gibt zurück:
      the value that was removed or default return value
      Siehe auch:
      Note:
      in some implementations key does not have to be T but just have to support equals with T.

    • remove

      boolean remove(T key, short value)
      Type Specific remove function to reduce boxing/unboxing
      Parameter:
      key - the element that should be removed
      value - the expected value that should be found
      Gibt zurück:
      true if the key and value was found and removed
      Siehe auch:

    • remove

      default boolean remove(Object key, Object value)
      Angegeben von:
      remove in Schnittstelle Map<T,Short>
      Parameter:
      key - the element that should be removed
      value - the expected value that should be found
      Gibt zurück:
      true if the key and value was found and removed
      Siehe auch:

    • remOrDefault

      short remOrDefault(T key, short defaultValue)
      Type-Specific Remove function with a default return value if wanted.
      Parameter:
      key - the element that should be removed
      defaultValue - the value that should be returned if the entry doesn't exist
      Gibt zurück:
      the value that was removed or default value
      Siehe auch:

    • replace

      boolean replace(T key, short oldValue, short newValue)
      A Type Specific replace method to replace an existing value
      Parameter:
      key - the element that should be searched for
      oldValue - the expected value to be replaced
      newValue - the value to replace the oldValue with.
      Gibt zurück:
      true if the value got replaced
      Note:
      this fails if the value is not present even if it matches the oldValue

    • replace

      short replace(T key, short value)
      A Type Specific replace method to reduce boxing/unboxing replace an existing value
      Parameter:
      key - the element that should be searched for
      value - the value to replace with.
      Gibt zurück:
      the present value or default return value
      Note:
      this fails if the value is not present

    • replaceShorts

      void replaceShorts(Object2ShortMap<T> m)
      Type-Specific bulk replace method. Could be seen as putAllIfPresent
      Parameter:
      m - elements that should be replaced.

    • replaceShorts

      void replaceShorts(ObjectShortUnaryOperator<T> mappingFunction)
      A Type Specific mass replace method to reduce boxing/unboxing
      Parameter:
      mappingFunction - operation to replace all values

    • computeShort

      short computeShort(T key, ObjectShortUnaryOperator<T> mappingFunction)
      A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value
      Gibt zurück:
      the result of the computation

    • computeShortIfAbsent

      short computeShortIfAbsent(T key, ToShortFunction<T> mappingFunction)
      A Type Specific computeIfAbsent method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value if not present
      Gibt zurück:
      the result of the computed value or present value

    • supplyShortIfAbsent

      short supplyShortIfAbsent(T key, ShortSupplier valueProvider)
      A Supplier based computeIfAbsent function to fill the most used usecase of this function If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Parameter:
      key - the key that should be computed
      valueProvider - the value if not present
      Gibt zurück:
      the result of the computed value or present value

    • computeShortIfPresent

      short computeShortIfPresent(T key, ObjectShortUnaryOperator<T> mappingFunction)
      A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value if present
      Gibt zurück:
      the result of the default return value or present value
      Note:
      if not present then compute is not executed

    • computeShortNonDefault

      short computeShortNonDefault(T key, ObjectShortUnaryOperator<T> mappingFunction)
      A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value
      Gibt zurück:
      the result of the computation

    • computeShortIfAbsentNonDefault

      short computeShortIfAbsentNonDefault(T key, ToShortFunction<T> mappingFunction)
      A Type Specific computeIfAbsent method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value if not present
      Gibt zurück:
      the result of the computed value or present value

    • supplyShortIfAbsentNonDefault

      short supplyShortIfAbsentNonDefault(T key, ShortSupplier valueProvider)
      A Supplier based computeIfAbsent function to fill the most used usecase of this function If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Parameter:
      key - the key that should be computed
      valueProvider - the value if not present
      Gibt zurück:
      the result of the computed value or present value

    • computeShortIfPresentNonDefault

      short computeShortIfPresentNonDefault(T key, ObjectShortUnaryOperator<T> mappingFunction)
      A Type Specific compute method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value if present
      Gibt zurück:
      the result of the default return value or present value
      Note:
      if not present then compute is not executed

    • mergeShort

      short mergeShort(T key, short value, ShortShortUnaryOperator mappingFunction)
      A Type Specific merge method to reduce boxing/unboxing If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Parameter:
      key - the key that should be be searched for
      value - the value that should be merged with
      mappingFunction - the operator that should generate the new Value
      Gibt zurück:
      the result of the merge
      Note:
      if the result matches the default return value then the key is removed from the map

    • mergeAllShort

      void mergeAllShort(Object2ShortMap<T> m, ShortShortUnaryOperator mappingFunction)
      A Bulk method for merging Maps. If the generated value equals the getDefaultReturnValue it will simply not insert it since that is treated as "null". A "Null Value" will be treated as "Do not insert/remove" based on how the Java has specified it.
      Parameter:
      m - the entries that should be bulk added
      mappingFunction - the operator that should generate the new Value
      Note:
      if the result matches the default return value then the key is removed from the map

    • replace

      default boolean replace(T key, Short oldValue, Short newValue)
      Angegeben von:
      replace in Schnittstelle Map<T,Short>

    • replace

      default Short replace(T key, Short value)
      Angegeben von:
      replace in Schnittstelle Map<T,Short>

    • applyAsShort

      default short applyAsShort(T key)
      Beschreibung aus Schnittstelle kopiert: ToShortFunction
      Type Specific get function to reduce boxing/unboxing
      Angegeben von:
      applyAsShort in Schnittstelle ToShortFunction<T>
      Parameter:
      key - the value that should be processed
      Gibt zurück:
      the result of the function

    • getShort

      short getShort(T key)
      A Type Specific get method to reduce boxing/unboxing
      Parameter:
      key - the key that is searched for
      Gibt zurück:
      the searched value or default return value

    • getOrDefault

      short getOrDefault(T key, short defaultValue)
      A Type Specific getOrDefault method to reduce boxing/unboxing
      Parameter:
      key - the key that is searched for
      defaultValue - the value that should be returned if the key is not present
      Gibt zurück:
      the searched value or defaultValue value

    • get

      default Short get(Object key)
      Angegeben von:
      get in Schnittstelle Map<T,Short>

    • getOrDefault

      default Short getOrDefault(Object key, Short defaultValue)
      Angegeben von:
      getOrDefault in Schnittstelle Map<T,Short>

    • replaceAll

      default void replaceAll(BiFunction<? super T,? super Short,? extends Short> mappingFunction)
      Angegeben von:
      replaceAll in Schnittstelle Map<T,Short>

    • compute

      default Short compute(T key, BiFunction<? super T,? super Short,? extends Short> mappingFunction)
      Angegeben von:
      compute in Schnittstelle Map<T,Short>

    • computeIfAbsent

      default Short computeIfAbsent(T key, Function<? super T,? extends Short> mappingFunction)
      Angegeben von:
      computeIfAbsent in Schnittstelle Map<T,Short>

    • computeIfPresent

      default Short computeIfPresent(T key, BiFunction<? super T,? super Short,? extends Short> mappingFunction)
      Angegeben von:
      computeIfPresent in Schnittstelle Map<T,Short>

    • merge

      default Short merge(T key, Short value, BiFunction<? super Short,? super Short,? extends Short> mappingFunction)
      Angegeben von:
      merge in Schnittstelle Map<T,Short>

    • forEach

      void forEach(ObjectShortConsumer<T> action)
      Type Specific forEach method to reduce boxing/unboxing
      Parameter:
      action - processor of the values that are iterator over

    • forEach

      default void forEach(BiConsumer<? super T,? super Short> action)
      Angegeben von:
      forEach in Schnittstelle Map<T,Short>

    • keySet

      ObjectSet<T> keySet()
      Angegeben von:
      keySet in Schnittstelle Map<T,Short>

    • values

      ShortCollection values()
      Angegeben von:
      values in Schnittstelle Map<T,Short>

    • entrySet

      ObjectSet<Map.Entry<T,Short>> entrySet()
      Angegeben von:
      entrySet in Schnittstelle Map<T,Short>

    • object2ShortEntrySet

      ObjectSet<Object2ShortMap.Entry<T>> object2ShortEntrySet()
      Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
      Gibt zurück:
      a EntrySet of the collection

    • synchronize

      default Object2ShortMap<T> synchronize()
      Creates a Wrapped Map that is Synchronized
      Gibt zurück:
      a new Map that is synchronized
      Siehe auch:

    • synchronize

      default Object2ShortMap<T> synchronize(Object mutex)
      Creates a Wrapped Map that is Synchronized
      Parameter:
      mutex - is the controller of the synchronization block
      Gibt zurück:
      a new Map Wrapper that is synchronized
      Siehe auch:

    • unmodifiable

      default Object2ShortMap<T> unmodifiable()
      Creates a Wrapped Map that is unmodifiable
      Gibt zurück:
      a new Map Wrapper that is unmodifiable
      Siehe auch:

    • put

      default Short put(T key, Short value)
      Angegeben von:
      put in Schnittstelle Map<T,Short>

    • putIfAbsent

      default Short putIfAbsent(T key, Short value)
      Angegeben von:
      putIfAbsent in Schnittstelle Map<T,Short>