Package org.apache.commons.collections4.keyvalue

Class AbstractKeyValue<K,​V>

  • Type Parameters:
    K - the type of keys
    V - the type of values
    All Implemented Interfaces:
    KeyValue<K,​V>
    Direct Known Subclasses:
    AbstractMapEntry, DefaultKeyValue
    public abstract class AbstractKeyValue<K,​V>
extends java.lang.Object
implements KeyValue<K,​V>
    Abstract pair class to assist with creating KeyValue and Map.Entry implementations.
    Since:
    3.0

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AbstractKeyValue​(K key, V value)
      Constructs a new pair with the specified key and given value.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      K getKey()
      Gets the key from the pair.
      V getValue()
      Gets the value from the pair.
      protected K setKey​(K key)
      Sets the key.
      protected V setValue​(V value)
      Sets the value.
      java.lang.String toString()
      Gets a debugging String view of the pair.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • AbstractKeyValue

        protected AbstractKeyValue​(K key,
                           V value)
        Constructs a new pair with the specified key and given value.
        Parameters:
        key - the key for the entry, may be null
        value - the value for the entry, may be null

    • Method Detail

      • getKey

        public K getKey()
        Gets the key from the pair.
        Specified by:
        getKey in interface KeyValue<K,​V>
        Returns:
        the key

      • getValue

        public V getValue()
        Gets the value from the pair.
        Specified by:
        getValue in interface KeyValue<K,​V>
        Returns:
        the value

      • setKey

        protected K setKey​(K key)
        Sets the key.
        Parameters:
        key - The key.
        Returns:
        The previous key.

      • setValue

        protected V setValue​(V value)
        Sets the value.
        Parameters:
        value - The value.
        Returns:
        The previous value.

      • toString

        public java.lang.String toString()
        Gets a debugging String view of the pair.
        Overrides:
        toString in class java.lang.Object
        Returns:
        a String view of the entry