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

Klasse Enum2BooleanMap<T extends Enum<T>>

java.lang.Object
java.util.AbstractMap<T,Boolean>
speiger.src.collections.objects.maps.abstracts.AbstractObject2BooleanMap<T>
speiger.src.collections.objects.maps.impl.misc.Enum2BooleanMap<T>
Typparameter:
T - the keyType of elements maintained by this Collection
Alle implementierten Schnittstellen:
Predicate<T>, Map<T,Boolean>, Object2BooleanMap<T>
Bekannte direkte Unterklassen:
LinkedEnum2BooleanMap
public class Enum2BooleanMap<T extends Enum<T>> extends AbstractObject2BooleanMap<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

    • Enum2BooleanMap

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

    • Enum2BooleanMap

      public Enum2BooleanMap(T[] keys, Boolean[] 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

    • Enum2BooleanMap

      public Enum2BooleanMap(T[] keys, boolean[] 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

    • Enum2BooleanMap

      public Enum2BooleanMap(Map<? extends T,? extends Boolean> 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

    • Enum2BooleanMap

      public Enum2BooleanMap(Object2BooleanMap<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 boolean put(T key, boolean value)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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 boolean putIfAbsent(T key, boolean value)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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>,Boolean>
      Setzt außer Kraft:
      containsKey in Klasse AbstractObject2BooleanMap<T extends Enum<T>>

    • containsValue

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

    • remove

      public Boolean remove(Object key)
      Angegeben von:
      remove in Schnittstelle Map<T extends Enum<T>,Boolean>
      Angegeben von:
      remove in Schnittstelle Object2BooleanMap<T extends Enum<T>>
      Setzt außer Kraft:
      remove in Klasse AbstractObject2BooleanMap<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 boolean rem(T key)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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 boolean remOrDefault(T key, boolean defaultValue)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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, boolean value)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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:

    • getBoolean

      public boolean getBoolean(T key)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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 boolean getOrDefault(T key, boolean defaultValue)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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 Enum2BooleanMap<T> copy()
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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 Object2BooleanMap<T extends Enum<T>>
      Setzt außer Kraft:
      copy in Klasse AbstractObject2BooleanMap<T extends Enum<T>>
      Gibt zurück:
      a Shallow Copy of the Map

    • object2BooleanEntrySet

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

    • values

      public BooleanCollection values()
      Angegeben von:
      values in Schnittstelle Map<T extends Enum<T>,Boolean>
      Angegeben von:
      values in Schnittstelle Object2BooleanMap<T extends Enum<T>>
      Setzt außer Kraft:
      values in Klasse AbstractObject2BooleanMap<T extends Enum<T>>

    • forEach

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

    • replace

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

    • computeBoolean

      public boolean computeBoolean(T key, ObjectBooleanUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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:
      computeBoolean in Schnittstelle Object2BooleanMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeBoolean in Klasse AbstractObject2BooleanMap<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

    • computeBooleanIfAbsent

      public boolean computeBooleanIfAbsent(T key, Predicate<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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:
      computeBooleanIfAbsent in Schnittstelle Object2BooleanMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeBooleanIfAbsent in Klasse AbstractObject2BooleanMap<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

    • supplyBooleanIfAbsent

      public boolean supplyBooleanIfAbsent(T key, BooleanSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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:
      supplyBooleanIfAbsent in Schnittstelle Object2BooleanMap<T extends Enum<T>>
      Setzt außer Kraft:
      supplyBooleanIfAbsent in Klasse AbstractObject2BooleanMap<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

    • computeBooleanIfPresent

      public boolean computeBooleanIfPresent(T key, ObjectBooleanUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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:
      computeBooleanIfPresent in Schnittstelle Object2BooleanMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeBooleanIfPresent in Klasse AbstractObject2BooleanMap<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

    • computeBooleanNonDefault

      public boolean computeBooleanNonDefault(T key, ObjectBooleanUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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:
      computeBooleanNonDefault in Schnittstelle Object2BooleanMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeBooleanNonDefault in Klasse AbstractObject2BooleanMap<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

    • computeBooleanIfAbsentNonDefault

      public boolean computeBooleanIfAbsentNonDefault(T key, Predicate<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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:
      computeBooleanIfAbsentNonDefault in Schnittstelle Object2BooleanMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeBooleanIfAbsentNonDefault in Klasse AbstractObject2BooleanMap<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

    • supplyBooleanIfAbsentNonDefault

      public boolean supplyBooleanIfAbsentNonDefault(T key, BooleanSupplier valueProvider)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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:
      supplyBooleanIfAbsentNonDefault in Schnittstelle Object2BooleanMap<T extends Enum<T>>
      Setzt außer Kraft:
      supplyBooleanIfAbsentNonDefault in Klasse AbstractObject2BooleanMap<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

    • computeBooleanIfPresentNonDefault

      public boolean computeBooleanIfPresentNonDefault(T key, ObjectBooleanUnaryOperator<T> mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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:
      computeBooleanIfPresentNonDefault in Schnittstelle Object2BooleanMap<T extends Enum<T>>
      Setzt außer Kraft:
      computeBooleanIfPresentNonDefault in Klasse AbstractObject2BooleanMap<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

    • mergeBoolean

      public boolean mergeBoolean(T key, boolean value, BooleanBooleanUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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:
      mergeBoolean in Schnittstelle Object2BooleanMap<T extends Enum<T>>
      Setzt außer Kraft:
      mergeBoolean in Klasse AbstractObject2BooleanMap<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

    • mergeAllBoolean

      public void mergeAllBoolean(Object2BooleanMap<T> m, BooleanBooleanUnaryOperator mappingFunction)
      Beschreibung aus Schnittstelle kopiert: Object2BooleanMap
      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:
      mergeAllBoolean in Schnittstelle Object2BooleanMap<T extends Enum<T>>
      Setzt außer Kraft:
      mergeAllBoolean in Klasse AbstractObject2BooleanMap<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>,Boolean>
      Setzt außer Kraft:
      clear in Klasse AbstractMap<T extends Enum<T>,Boolean>

    • size

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