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

Klasse Enum2ObjectMap<T extends Enum<T>,V>

java.lang.Object
java.util.AbstractMap<T,V>
speiger.src.collections.objects.maps.abstracts.AbstractObject2ObjectMap<T,V>
speiger.src.collections.objects.maps.impl.misc.Enum2ObjectMap<T,V>
Typparameter:
T - the keyType of elements maintained by this Collection
V - the keyType of elements maintained by this Collection
Alle implementierten Schnittstellen:
Function<T,V>, Map<T,V>, UnaryOperator<T,V>, Object2ObjectMap<T,V>
Bekannte direkte Unterklassen:
LinkedEnum2ObjectMap
public class Enum2ObjectMap<T extends Enum<T>,V> extends AbstractObject2ObjectMap<T,V>
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

    • Enum2ObjectMap

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

    • Enum2ObjectMap

      public Enum2ObjectMap(T[] keys, V[] 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

    • Enum2ObjectMap

      public Enum2ObjectMap(Map<? extends T,? extends V> 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

    • Enum2ObjectMap

      public Enum2ObjectMap(Object2ObjectMap<T,V> 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 V put(T key, V value)
      Beschreibung aus Schnittstelle kopiert: Object2ObjectMap
      Type Specific method to reduce boxing/unboxing of values
      Angegeben von:
      put in Schnittstelle Map<T extends Enum<T>,V>
      Angegeben von:
      put in Schnittstelle Object2ObjectMap<T extends Enum<T>,V>
      Setzt außer Kraft:
      put in Klasse AbstractMap<T extends Enum<T>,V>
      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 V putIfAbsent(T key, V value)
      Beschreibung aus Schnittstelle kopiert: Object2ObjectMap
      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:

    • containsKey

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

    • containsValue

      public boolean containsValue(Object value)
      Angegeben von:
      containsValue in Schnittstelle Map<T extends Enum<T>,V>
      Setzt außer Kraft:
      containsValue in Klasse AbstractObject2ObjectMap<T extends Enum<T>,V>

    • remove

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

    • rem

      public V rem(T key)
      Beschreibung aus Schnittstelle kopiert: Object2ObjectMap
      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 V remOrDefault(T key, V defaultValue)
      Beschreibung aus Schnittstelle kopiert: Object2ObjectMap
      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(Object key, Object value)

    • getObject

      public V getObject(T key)
      Beschreibung aus Schnittstelle kopiert: Object2ObjectMap
      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 V getOrDefault(Object key, V defaultValue)
      Angegeben von:
      getOrDefault in Schnittstelle Map<T extends Enum<T>,V>
      Setzt außer Kraft:
      getOrDefault in Klasse AbstractObject2ObjectMap<T extends Enum<T>,V>

    • copy

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

    • object2ObjectEntrySet

      public ObjectSet<Object2ObjectMap.Entry<T,V>> object2ObjectEntrySet()
      Beschreibung aus Schnittstelle kopiert: Object2ObjectMap
      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>,V>
      Angegeben von:
      keySet in Schnittstelle Object2ObjectMap<T extends Enum<T>,V>
      Setzt außer Kraft:
      keySet in Klasse AbstractObject2ObjectMap<T extends Enum<T>,V>

    • values

      public ObjectCollection<V> values()
      Angegeben von:
      values in Schnittstelle Map<T extends Enum<T>,V>
      Angegeben von:
      values in Schnittstelle Object2ObjectMap<T extends Enum<T>,V>
      Setzt außer Kraft:
      values in Klasse AbstractObject2ObjectMap<T extends Enum<T>,V>

    • forEach

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

    • replace

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

    • compute

      public V compute(T key, ObjectObjectUnaryOperator<T,V> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ObjectMap
      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:
      compute in Schnittstelle Object2ObjectMap<T extends Enum<T>,V>
      Setzt außer Kraft:
      compute in Klasse AbstractObject2ObjectMap<T extends Enum<T>,V>
      Parameter:
      key - the key that should be computed
      mappingFunction - the operator that should generate the value
      Gibt zurück:
      the result of the computation

    • computeIfAbsent

      public V computeIfAbsent(T key, UnaryOperator<T,V> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ObjectMap
      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:
      computeIfAbsent in Schnittstelle Object2ObjectMap<T extends Enum<T>,V>
      Setzt außer Kraft:
      computeIfAbsent in Klasse AbstractObject2ObjectMap<T extends Enum<T>,V>
      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

    • supplyIfAbsent

      public V supplyIfAbsent(T key, ObjectSupplier<V> valueProvider)
      Beschreibung aus Schnittstelle kopiert: Object2ObjectMap
      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:
      supplyIfAbsent in Schnittstelle Object2ObjectMap<T extends Enum<T>,V>
      Setzt außer Kraft:
      supplyIfAbsent in Klasse AbstractObject2ObjectMap<T extends Enum<T>,V>
      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

    • computeIfPresent

      public V computeIfPresent(T key, ObjectObjectUnaryOperator<T,V> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ObjectMap
      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:
      computeIfPresent in Schnittstelle Object2ObjectMap<T extends Enum<T>,V>
      Setzt außer Kraft:
      computeIfPresent in Klasse AbstractObject2ObjectMap<T extends Enum<T>,V>
      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

    • merge

      public V merge(T key, V value, ObjectObjectUnaryOperator<V,V> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ObjectMap
      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:
      merge in Schnittstelle Object2ObjectMap<T extends Enum<T>,V>
      Setzt außer Kraft:
      merge in Klasse AbstractObject2ObjectMap<T extends Enum<T>,V>
      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

    • mergeAll

      public void mergeAll(Object2ObjectMap<T,V> m, ObjectObjectUnaryOperator<V,V> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2ObjectMap
      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:
      mergeAll in Schnittstelle Object2ObjectMap<T extends Enum<T>,V>
      Setzt außer Kraft:
      mergeAll in Klasse AbstractObject2ObjectMap<T extends Enum<T>,V>
      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>,V>
      Setzt außer Kraft:
      clear in Klasse AbstractMap<T extends Enum<T>,V>

    • size

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