Modul speiger.src.collections
Package speiger.src.collections.objects.maps.impl.misc

Klasse Object2ShortArrayMap<T>

java.lang.Object
java.util.AbstractMap<T,Short>
speiger.src.collections.objects.maps.abstracts.AbstractObject2ShortMap<T>
speiger.src.collections.objects.maps.impl.misc.Object2ShortArrayMap<T>
Typparameter:
T - the keyType of elements maintained by this Collection
Alle implementierten Schnittstellen:
Map<T,Short>, ToShortFunction<T>, Object2ShortMap<T>, Object2ShortOrderedMap<T>
public class Object2ShortArrayMap<T> extends AbstractObject2ShortMap<T> implements Object2ShortOrderedMap<T>
A Very Specific Type Specific implementation of a ArrayMap. This type of map is for very specific use cases that usaully would have lead to Tupled Lists otherwise. It also does not allow duplication (except for array constructors) and checks from last to first. It is not designed to be used as a HashMap replacement due to the poor performance it would cause.
Note:
in this implementation SubMaps do NOT keep track of parent changes fully. For performance reasons it will just have a start/end index and not values Anything within that range will be updated appropiatly a shrink/growth of elements will break SubMaps in some ways. This can be useful but be careful, this implementation does not shrink and only grows.

  • Konstruktordetails

    • Object2ShortArrayMap

      public Object2ShortArrayMap()
      Default Constructor

    • Object2ShortArrayMap

      public Object2ShortArrayMap(int minCapacity)
      Constructor that defines the minimum capacity
      Parameter:
      minCapacity - the minimum capacity the HashMap is allowed to be.
      Löst aus:
      IllegalStateException - if the minimum capacity is negative

    • Object2ShortArrayMap

      public Object2ShortArrayMap(T[] keys, Short[] values)
      Helper constructor that allow to create a map from boxed values (it will unbox them)
      Parameter:
      keys - the keys that should be put into the map
      values - the values that should be put into the map.
      Löst aus:
      IllegalStateException - if the keys and values do not match in length

    • Object2ShortArrayMap

      public Object2ShortArrayMap(T[] keys, Short[] values, int length)
      Helper constructor that allow to create a map from boxed values (it will unbox them) with a custom length
      Parameter:
      keys - the keys that should be put into the map
      values - the values that should be put into the map.
      length - the amount of values that should be pulled from the array
      Löst aus:
      IllegalStateException - if the keys and values do not match in length

    • Object2ShortArrayMap

      public Object2ShortArrayMap(T[] keys, short[] values)
      Helper constructor that allow to create a map from unboxed values
      Parameter:
      keys - the keys that should be put into the map
      values - the values that should be put into the map.
      Löst aus:
      IllegalStateException - if the keys and values do not match in lenght

    • Object2ShortArrayMap

      public Object2ShortArrayMap(T[] keys, short[] values, int length)
      Helper constructor that allow to create a map from unboxed values
      Parameter:
      keys - the keys that should be put into the map
      values - the values that should be put into the map.
      length - the amount of values that should be pulled from the array
      Löst aus:
      IllegalStateException - if the keys and values do not match in lenght

    • Object2ShortArrayMap

      public Object2ShortArrayMap(Map<? extends T,? extends Short> map)
      A Helper constructor that allows to create a Map with exactly the same values as the provided map.
      Parameter:
      map - the values that should be present in the map

    • Object2ShortArrayMap

      public Object2ShortArrayMap(Object2ShortMap<T> map)
      A Type Specific Helper function that allows to create a new Map with exactly the same values as the provided map.
      Parameter:
      map - the values that should be present in the map

  • Methodendetails

    • put

      public short put(T key, short value)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      put in Schnittstelle Object2ShortMap<T>
      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:

    • putIfAbsent

      public short putIfAbsent(T key, short value)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      putIfAbsent in Schnittstelle Object2ShortMap<T>
      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:

    • addTo

      public short addTo(T key, short value)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      A Helper method to add a primitives together. If key is not present then this functions as a put.
      Angegeben von:
      addTo in Schnittstelle Object2ShortMap<T>
      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.

    • subFrom

      public short subFrom(T key, short value)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      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 Object2ShortMap.getDefaultReturnValue() If the fence is reached the element will be automaticall removed
      Angegeben von:
      subFrom in Schnittstelle Object2ShortMap<T>
      Parameter:
      key - that should be subtract from
      value - that should be subtract
      Gibt zurück:
      the last present or default return value

    • putAndMoveToFirst

      public short putAndMoveToFirst(T key, short value)
      Beschreibung aus Schnittstelle kopiert: Object2ShortOrderedMap
      A customized put method that allows you to insert into the first index.
      Angegeben von:
      putAndMoveToFirst in Schnittstelle Object2ShortOrderedMap<T>
      Parameter:
      key - the key that should be inserted
      value - the value that should be inserted
      Gibt zurück:
      the previous present or default return value
      Siehe auch:

    • putAndMoveToLast

      public short putAndMoveToLast(T key, short value)
      Beschreibung aus Schnittstelle kopiert: Object2ShortOrderedMap
      A customized put method that allows you to insert into the last index. (This may be nessesary depending on the implementation)
      Angegeben von:
      putAndMoveToLast in Schnittstelle Object2ShortOrderedMap<T>
      Parameter:
      key - the key that should be inserted
      value - the value that should be inserted
      Gibt zurück:
      the previous present or default return value
      Siehe auch:

    • moveToFirst

      public boolean moveToFirst(T key)
      Beschreibung aus Schnittstelle kopiert: Object2ShortOrderedMap
      A specific move method to move a given key/value to the first index.
      Angegeben von:
      moveToFirst in Schnittstelle Object2ShortOrderedMap<T>
      Parameter:
      key - that should be moved to the first index
      Gibt zurück:
      true if the value was moved.

    • moveToLast

      public boolean moveToLast(T key)
      Beschreibung aus Schnittstelle kopiert: Object2ShortOrderedMap
      A specific move method to move a given key/value to the last index.
      Angegeben von:
      moveToLast in Schnittstelle Object2ShortOrderedMap<T>
      Parameter:
      key - that should be moved to the first last
      Gibt zurück:
      true if the value was moved.

    • containsValue

      public boolean containsValue(short value)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      containsValue in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      containsValue in Klasse AbstractObject2ShortMap<T>
      Parameter:
      value - element that is searched for
      Gibt zurück:
      if the value is present

    • containsKey

      public boolean containsKey(Object key)
      Angegeben von:
      containsKey in Schnittstelle Map<T,Short>
      Setzt außer Kraft:
      containsKey in Klasse AbstractObject2ShortMap<T>

    • containsValue

      public boolean containsValue(Object value)
      Angegeben von:
      containsValue in Schnittstelle Map<T,Short>
      Angegeben von:
      containsValue in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      containsValue in Klasse AbstractMap<T,Short>
      Parameter:
      value - that is searched for.
      Gibt zurück:
      true if found
      Siehe auch:

    • getShort

      public short getShort(T key)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      A Type Specific get method to reduce boxing/unboxing
      Angegeben von:
      getShort in Schnittstelle Object2ShortMap<T>
      Parameter:
      key - the key that is searched for
      Gibt zurück:
      the searched value or default return value

    • getOrDefault

      public short getOrDefault(Object key, short defaultValue)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      A Type Specific getOrDefault method to reduce boxing/unboxing
      Angegeben von:
      getOrDefault in Schnittstelle Object2ShortMap<T>
      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

    • getAndMoveToFirst

      public short getAndMoveToFirst(T key)
      Beschreibung aus Schnittstelle kopiert: Object2ShortOrderedMap
      A Specific get method that allows to move teh given key/value int the first index.
      Angegeben von:
      getAndMoveToFirst in Schnittstelle Object2ShortOrderedMap<T>
      Parameter:
      key - that is searched for
      Gibt zurück:
      the given value for the requested key or default return value

    • getAndMoveToLast

      public short getAndMoveToLast(T key)
      Beschreibung aus Schnittstelle kopiert: Object2ShortOrderedMap
      A Specific get method that allows to move teh given key/value int the last index.
      Angegeben von:
      getAndMoveToLast in Schnittstelle Object2ShortOrderedMap<T>
      Parameter:
      key - that is searched for
      Gibt zurück:
      the given value for the requested key or default return value

    • firstKey

      public T firstKey()
      Beschreibung aus Schnittstelle kopiert: Object2ShortOrderedMap
      A method to get the first Key of a Map.
      Angegeben von:
      firstKey in Schnittstelle Object2ShortOrderedMap<T>
      Gibt zurück:
      the first key in the map

    • lastKey

      public T lastKey()
      Beschreibung aus Schnittstelle kopiert: Object2ShortOrderedMap
      A method to get the last Key of a Map.
      Angegeben von:
      lastKey in Schnittstelle Object2ShortOrderedMap<T>
      Gibt zurück:
      the last key in the map

    • firstShortValue

      public short firstShortValue()
      Beschreibung aus Schnittstelle kopiert: Object2ShortOrderedMap
      A method to get the first Value of a Map.
      Angegeben von:
      firstShortValue in Schnittstelle Object2ShortOrderedMap<T>
      Gibt zurück:
      the first key in the map

    • lastShortValue

      public short lastShortValue()
      Beschreibung aus Schnittstelle kopiert: Object2ShortOrderedMap
      A method to get the last Value of a Map.
      Angegeben von:
      lastShortValue in Schnittstelle Object2ShortOrderedMap<T>
      Gibt zurück:
      the last key in the map

    • pollFirstKey

      public T pollFirstKey()
      Beschreibung aus Schnittstelle kopiert: Object2ShortOrderedMap
      A method to get and remove the first Key of a Map.
      Angegeben von:
      pollFirstKey in Schnittstelle Object2ShortOrderedMap<T>
      Gibt zurück:
      the first key in the map

    • pollLastKey

      public T pollLastKey()
      Beschreibung aus Schnittstelle kopiert: Object2ShortOrderedMap
      A method to get and remove the last Key of a Map.
      Angegeben von:
      pollLastKey in Schnittstelle Object2ShortOrderedMap<T>
      Gibt zurück:
      the last key in the map

    • rem

      public short rem(T key)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      Type Specific remove function to reduce boxing/unboxing
      Angegeben von:
      rem in Schnittstelle Object2ShortMap<T>
      Parameter:
      key - the element that should be removed
      Gibt zurück:
      the value that was removed or default return value

    • remOrDefault

      public short remOrDefault(T key, short defaultValue)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      Type-Specific Remove function with a default return value if wanted.
      Angegeben von:
      remOrDefault in Schnittstelle Object2ShortMap<T>
      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:

    • remove

      public boolean remove(T key, short value)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      Type Specific remove function to reduce boxing/unboxing
      Angegeben von:
      remove in Schnittstelle Object2ShortMap<T>
      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

      public Short remove(Object key)
      Angegeben von:
      remove in Schnittstelle Map<T,Short>
      Angegeben von:
      remove in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      remove in Klasse AbstractObject2ShortMap<T>
      Parameter:
      key - the element that should be removed
      Gibt zurück:
      the value that was removed or default return value
      Siehe auch:

    • remove

      public boolean remove(Object key, Object value)
      Angegeben von:
      remove in Schnittstelle Map<T,Short>
      Angegeben von:
      remove in Schnittstelle Object2ShortMap<T>
      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:

    • forEach

      public void forEach(ObjectShortConsumer<T> action)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      Type Specific forEach method to reduce boxing/unboxing
      Angegeben von:
      forEach in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      forEach in Klasse AbstractObject2ShortMap<T>
      Parameter:
      action - processor of the values that are iterator over

    • keySet

      public ObjectOrderedSet<T> keySet()
      Angegeben von:
      keySet in Schnittstelle Map<T,Short>
      Angegeben von:
      keySet in Schnittstelle Object2ShortMap<T>
      Angegeben von:
      keySet in Schnittstelle Object2ShortOrderedMap<T>
      Setzt außer Kraft:
      keySet in Klasse AbstractObject2ShortMap<T>

    • values

      public ShortCollection values()
      Angegeben von:
      values in Schnittstelle Map<T,Short>
      Angegeben von:
      values in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      values in Klasse AbstractObject2ShortMap<T>

    • object2ShortEntrySet

      public ObjectOrderedSet<Object2ShortMap.Entry<T>> object2ShortEntrySet()
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
      Angegeben von:
      object2ShortEntrySet in Schnittstelle Object2ShortMap<T>
      Angegeben von:
      object2ShortEntrySet in Schnittstelle Object2ShortOrderedMap<T>
      Gibt zurück:
      a EntrySet of the collection

    • replace

      public boolean replace(T key, short oldValue, short newValue)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      A Type Specific replace method to replace an existing value
      Angegeben von:
      replace in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      replace in Klasse AbstractObject2ShortMap<T>
      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

    • replace

      public short replace(T key, short value)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      A Type Specific replace method to reduce boxing/unboxing replace an existing value
      Angegeben von:
      replace in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      replace in Klasse AbstractObject2ShortMap<T>
      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

    • computeShort

      public short computeShort(T key, ObjectShortUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      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.
      Angegeben von:
      computeShort in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      computeShort in Klasse AbstractObject2ShortMap<T>
      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

      public short computeShortIfAbsent(T key, ToShortFunction<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      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.
      Angegeben von:
      computeShortIfAbsent in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      computeShortIfAbsent in Klasse AbstractObject2ShortMap<T>
      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

      public short supplyShortIfAbsent(T key, ShortSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      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.
      Angegeben von:
      supplyShortIfAbsent in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      supplyShortIfAbsent in Klasse AbstractObject2ShortMap<T>
      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

      public short computeShortIfPresent(T key, ObjectShortUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      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.
      Angegeben von:
      computeShortIfPresent in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      computeShortIfPresent in Klasse AbstractObject2ShortMap<T>
      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

    • computeShortNonDefault

      public short computeShortNonDefault(T key, ObjectShortUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      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.
      Angegeben von:
      computeShortNonDefault in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      computeShortNonDefault in Klasse AbstractObject2ShortMap<T>
      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

      public short computeShortIfAbsentNonDefault(T key, ToShortFunction<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      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.
      Angegeben von:
      computeShortIfAbsentNonDefault in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      computeShortIfAbsentNonDefault in Klasse AbstractObject2ShortMap<T>
      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

      public short supplyShortIfAbsentNonDefault(T key, ShortSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      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.
      Angegeben von:
      supplyShortIfAbsentNonDefault in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      supplyShortIfAbsentNonDefault in Klasse AbstractObject2ShortMap<T>
      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

      public short computeShortIfPresentNonDefault(T key, ObjectShortUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      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.
      Angegeben von:
      computeShortIfPresentNonDefault in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      computeShortIfPresentNonDefault in Klasse AbstractObject2ShortMap<T>
      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

    • mergeShort

      public short mergeShort(T key, short value, ShortShortUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      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.
      Angegeben von:
      mergeShort in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      mergeShort in Klasse AbstractObject2ShortMap<T>
      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

    • mergeAllShort

      public void mergeAllShort(Object2ShortMap<T> m, ShortShortUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      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.
      Angegeben von:
      mergeAllShort in Schnittstelle Object2ShortMap<T>
      Setzt außer Kraft:
      mergeAllShort in Klasse AbstractObject2ShortMap<T>
      Parameter:
      m - the entries that should be bulk added
      mappingFunction - the operator that should generate the new Value

    • size

      public int size()
      Angegeben von:
      size in Schnittstelle Map<T,Short>
      Setzt außer Kraft:
      size in Klasse AbstractMap<T,Short>

    • clear

      public void clear()
      Angegeben von:
      clear in Schnittstelle Map<T,Short>
      Setzt außer Kraft:
      clear in Klasse AbstractMap<T,Short>

    • copy

      public Object2ShortArrayMap<T> copy()
      Beschreibung aus Schnittstelle kopiert: Object2ShortMap
      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
      Angegeben von:
      copy in Schnittstelle Object2ShortMap<T>
      Angegeben von:
      copy in Schnittstelle Object2ShortOrderedMap<T>
      Setzt außer Kraft:
      copy in Klasse AbstractObject2ShortMap<T>
      Gibt zurück:
      a Shallow Copy of the Map