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

Klasse Enum2ByteMap<T extends Enum<T>>

java.lang.Object
java.util.AbstractMap<T,Byte>
speiger.src.collections.objects.maps.abstracts.AbstractObject2ByteMap<T>
speiger.src.collections.objects.maps.impl.misc.Enum2ByteMap<T>
Typparameter:
T - the keyType of elements maintained by this Collection
Alle implementierten Schnittstellen:
Map<T,Byte>, ToByteFunction<T>, Object2ByteMap<T>
Bekannte direkte Unterklassen:
LinkedEnum2ByteMap
public class Enum2ByteMap<T extends Enum<T>> extends AbstractObject2ByteMap<T>
A Type Specific EnumMap implementation that allows for Primitive Values. Unlike javas implementation this one does not jump around between a single long or long array implementation based around the enum size This will cause a bit more memory usage but allows for a simpler implementation.

  • Konstruktordetails

    • Enum2ByteMap

      public Enum2ByteMap(Class<T> keyType)
      Default Constructor
      Parameter:
      keyType - the type of Enum that should be used

    • Enum2ByteMap

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

    • Enum2ByteMap

      public Enum2ByteMap(T[] keys, byte[] values)
      Helper constructor that allow to create a EnumMap 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

    • Enum2ByteMap

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

    • Enum2ByteMap

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

  • Methodendetails

    • put

      public byte put(T key, byte value)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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:

    • putIfAbsent

      public byte putIfAbsent(T key, byte value)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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:

    • addTo

      public byte addTo(T key, byte value)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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.

    • subFrom

      public byte subFrom(T key, byte value)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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 Object2ByteMap.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

    • containsKey

      public boolean containsKey(Object key)
      Angegeben von:
      containsKey in Schnittstelle Map<T extends Enum<T>,Byte>
      Setzt außer Kraft:
      containsKey in Klasse AbstractObject2ByteMap<T extends Enum<T>>

    • containsValue

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

    • remove

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

    • rem

      public byte rem(T key)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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

    • remOrDefault

      public byte remOrDefault(T key, byte defaultValue)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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:

    • remove

      public boolean remove(T key, byte value)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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:

    • getByte

      public byte getByte(T key)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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

      public byte getOrDefault(T key, byte defaultValue)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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

    • copy

      public Enum2ByteMap<T> copy()
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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 Object2ByteMap<T extends Enum<T>>
      Setzt außer Kraft:
      copy in Klasse AbstractObject2ByteMap<T extends Enum<T>>
      Gibt zurück:
      a Shallow Copy of the Map

    • object2ByteEntrySet

      public ObjectSet<Object2ByteMap.Entry<T>> object2ByteEntrySet()
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      Type Sensitive EntrySet to reduce boxing/unboxing and optionally Temp Object Allocation.
      Gibt zurück:
      a EntrySet of the collection

    • keySet

      public ObjectSet<T> keySet()
      Angegeben von:
      keySet in Schnittstelle Map<T extends Enum<T>,Byte>
      Angegeben von:
      keySet in Schnittstelle Object2ByteMap<T extends Enum<T>>
      Setzt außer Kraft:
      keySet in Klasse AbstractObject2ByteMap<T extends Enum<T>>

    • values

      public ByteCollection values()
      Angegeben von:
      values in Schnittstelle Map<T extends Enum<T>,Byte>
      Angegeben von:
      values in Schnittstelle Object2ByteMap<T extends Enum<T>>
      Setzt außer Kraft:
      values in Klasse AbstractObject2ByteMap<T extends Enum<T>>

    • forEach

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

    • replace

      public boolean replace(T key, byte oldValue, byte newValue)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      A Type Specific replace method to replace an existing value
      Angegeben von:
      replace in Schnittstelle Object2ByteMap<T extends Enum<T>>
      Setzt außer Kraft:
      replace in Klasse AbstractObject2ByteMap<T extends Enum<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 byte replace(T key, byte value)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      A Type Specific replace method to reduce boxing/unboxing replace an existing value
      Angegeben von:
      replace in Schnittstelle Object2ByteMap<T extends Enum<T>>
      Setzt außer Kraft:
      replace in Klasse AbstractObject2ByteMap<T extends Enum<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

    • computeByte

      public byte computeByte(T key, ObjectByteUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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:
      computeByte in Schnittstelle Object2ByteMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeByte in Klasse AbstractObject2ByteMap<T extends Enum<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

    • computeByteIfAbsent

      public byte computeByteIfAbsent(T key, ToByteFunction<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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:
      computeByteIfAbsent in Schnittstelle Object2ByteMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeByteIfAbsent in Klasse AbstractObject2ByteMap<T extends Enum<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

    • supplyByteIfAbsent

      public byte supplyByteIfAbsent(T key, ByteSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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:
      supplyByteIfAbsent in Schnittstelle Object2ByteMap<T extends Enum<T>>
      Setzt außer Kraft:
      supplyByteIfAbsent in Klasse AbstractObject2ByteMap<T extends Enum<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

    • computeByteIfPresent

      public byte computeByteIfPresent(T key, ObjectByteUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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:
      computeByteIfPresent in Schnittstelle Object2ByteMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeByteIfPresent in Klasse AbstractObject2ByteMap<T extends Enum<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

    • computeByteNonDefault

      public byte computeByteNonDefault(T key, ObjectByteUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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:
      computeByteNonDefault in Schnittstelle Object2ByteMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeByteNonDefault in Klasse AbstractObject2ByteMap<T extends Enum<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

    • computeByteIfAbsentNonDefault

      public byte computeByteIfAbsentNonDefault(T key, ToByteFunction<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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:
      computeByteIfAbsentNonDefault in Schnittstelle Object2ByteMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeByteIfAbsentNonDefault in Klasse AbstractObject2ByteMap<T extends Enum<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

    • supplyByteIfAbsentNonDefault

      public byte supplyByteIfAbsentNonDefault(T key, ByteSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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:
      supplyByteIfAbsentNonDefault in Schnittstelle Object2ByteMap<T extends Enum<T>>
      Setzt außer Kraft:
      supplyByteIfAbsentNonDefault in Klasse AbstractObject2ByteMap<T extends Enum<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

    • computeByteIfPresentNonDefault

      public byte computeByteIfPresentNonDefault(T key, ObjectByteUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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:
      computeByteIfPresentNonDefault in Schnittstelle Object2ByteMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeByteIfPresentNonDefault in Klasse AbstractObject2ByteMap<T extends Enum<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

    • mergeByte

      public byte mergeByte(T key, byte value, ByteByteUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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:
      mergeByte in Schnittstelle Object2ByteMap<T extends Enum<T>>
      Setzt außer Kraft:
      mergeByte in Klasse AbstractObject2ByteMap<T extends Enum<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

    • mergeAllByte

      public void mergeAllByte(Object2ByteMap<T> m, ByteByteUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ByteMap
      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:
      mergeAllByte in Schnittstelle Object2ByteMap<T extends Enum<T>>
      Setzt außer Kraft:
      mergeAllByte in Klasse AbstractObject2ByteMap<T extends Enum<T>>
      Parameter:
      m - the entries that should be bulk added
      mappingFunction - the operator that should generate the new Value

    • clear

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

    • size

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