Package org.hipparchus.util

Class Pair<K,​V>

  • Type Parameters:
    K - Key type.
    V - Value type.
    Direct Known Subclasses:
    PointValuePair, PointVectorValuePair
    public class Pair<K,​V>
extends Object
    Generic pair.

    Although the instances of this class are immutable, it is impossible to ensure that the references passed to the constructor will not be modified by the caller.

    • Constructor Detail

      • Pair

        public Pair​(K k,
            V v)
        Create an entry representing a mapping from the specified key to the specified value.
        Parameters:
        k - Key (first element of the pair).
        v - Value (second element of the pair).

      • Pair

        public Pair​(Pair<? extends K,​? extends V> entry)
        Create an entry representing the same mapping as the specified entry.
        Parameters:
        entry - Entry to copy.

    • Method Detail

      • getKey

        public K getKey()
        Get the key.
        Returns:
        the key (first element of the pair).

      • getValue

        public V getValue()
        Get the value.
        Returns:
        the value (second element of the pair).

      • getFirst

        public K getFirst()
        Get the first element of the pair.
        Returns:
        the first element of the pair.

      • getSecond

        public V getSecond()
        Get the second element of the pair.
        Returns:
        the second element of the pair.

      • equals

        public boolean equals​(Object o)
        Compare the specified object with this entry for equality.
        Overrides:
        equals in class Object
        Parameters:
        o - Object.
        Returns:
        true if the given object is also a map entry and the two entries represent the same mapping.

      • hashCode

        public int hashCode()
        Compute a hash code.
        Overrides:
        hashCode in class Object
        Returns:
        the hash code value.

      • create

        public static <K,​V> Pair<K,​V> create​(K k,
                                                 V v)
        Convenience factory method that calls the constructor.
        Type Parameters:
        K - the key type
        V - the value type
        Parameters:
        k - First element of the pair.
        v - Second element of the pair.
        Returns:
        a new Pair containing k and v.