Modul speiger.src.collections
Package speiger.src.collections.objects.misc.pairs

Schnittstelle ObjectObjectPair<T,V>

Typparameter:
T - the keyType of elements maintained by this Collection
V - the keyType of elements maintained by this Collection
Alle bekannten Implementierungsklassen:
ObjectObjectImmutablePair, ObjectObjectMutablePair
public interface ObjectObjectPair<T,V>
Key Value Pair Interface that allows to reduce boxing/unboxing.

  • Felddetails

    • EMPTY

      static final ObjectObjectPair<?,?> EMPTY
      Empty Reference for Immutable Pairs

  • Methodendetails

    • of

      static <T, V> ObjectObjectPair<T,V> of()
      Typparameter:
      T - the keyType of elements maintained by this Collection
      V - the keyType of elements maintained by this Collection
      Gibt zurück:
      empty Immutable Pair

    • ofKey

      static <T, V> ObjectObjectPair<T,V> ofKey(T key)
      Typparameter:
      T - the keyType of elements maintained by this Collection
      V - the keyType of elements maintained by this Collection
      Parameter:
      key - the key that should be in the pair
      Gibt zurück:
      Immutable Pair of Key

    • ofValue

      static <T, V> ObjectObjectPair<T,V> ofValue(V value)
      Typparameter:
      T - the keyType of elements maintained by this Collection
      V - the keyType of elements maintained by this Collection
      Parameter:
      value - the value that should be in the pair
      Gibt zurück:
      Immutable Pair of Value

    • of

      static <T, V> ObjectObjectPair<T,V> of(T key, V value)
      Typparameter:
      T - the keyType of elements maintained by this Collection
      V - the keyType of elements maintained by this Collection
      Parameter:
      key - the key that should be in the pair
      value - the value that should be in the pair
      Gibt zurück:
      Immutable Pair of key and value

    • of

      static <T, V> ObjectObjectPair<T,V> of(ObjectObjectPair<T,V> pair)
      Typparameter:
      T - the keyType of elements maintained by this Collection
      V - the keyType of elements maintained by this Collection
      Parameter:
      pair - the Pair that should be immutably copied
      Gibt zurück:
      a Immutable Copy of the Provided Pair

    • mutable

      static <T, V> ObjectObjectPair<T,V> mutable()
      Typparameter:
      T - the keyType of elements maintained by this Collection
      V - the keyType of elements maintained by this Collection
      Gibt zurück:
      empty Mutable Pair

    • mutableKey

      static <T, V> ObjectObjectPair<T,V> mutableKey(T key)
      Typparameter:
      T - the keyType of elements maintained by this Collection
      V - the keyType of elements maintained by this Collection
      Parameter:
      key - the key that should be in the pair
      Gibt zurück:
      Mutable Pair of key

    • mutableValue

      static <T, V> ObjectObjectPair<T,V> mutableValue(V value)
      Typparameter:
      T - the keyType of elements maintained by this Collection
      V - the keyType of elements maintained by this Collection
      Parameter:
      value - the value that should be in the pair
      Gibt zurück:
      Mutable Pair of value

    • mutable

      static <T, V> ObjectObjectPair<T,V> mutable(T key, V value)
      Typparameter:
      T - the keyType of elements maintained by this Collection
      V - the keyType of elements maintained by this Collection
      Parameter:
      key - the key that should be in the pair
      value - the value that should be in the pair
      Gibt zurück:
      Mutable Pair of key and value

    • mutable

      static <T, V> ObjectObjectPair<T,V> mutable(ObjectObjectPair<T,V> pair)
      Typparameter:
      T - the keyType of elements maintained by this Collection
      V - the keyType of elements maintained by this Collection
      Parameter:
      pair - the Pair that should be copied
      Gibt zurück:
      a Mutable Copy of the Provided Pair

    • setKey

      ObjectObjectPair<T,V> setKey(T key)
      Sets the Key of the Pair.
      Parameter:
      key - the key that should be set.
      Gibt zurück:
      self or a new Pair instance with the new key.

    • getKey

      T getKey()
      Gibt zurück:
      the Key of the Pair

    • setValue

      ObjectObjectPair<T,V> setValue(V value)
      Sets the Value of the Pair.
      Parameter:
      value - the value that should be set.
      Gibt zurück:
      self or a new Pair instance with the new value.

    • getValue

      V getValue()
      Gibt zurück:
      the Value of the Pair

    • set

      ObjectObjectPair<T,V> set(T key, V value)
      Sets key and value of the Pair
      Parameter:
      key - the key that should be set.
      value - the value that should be set.
      Gibt zurück:
      self or a new Pair instance with the new key and value.

    • shallowCopy

      ObjectObjectPair<T,V> shallowCopy()
      Clones the Pair if it is mutable.
      Gibt zurück:
      a New Mutable Instance if it is mutable