Class AbstractMapEntry<K,​V>

  • Type Parameters:
    K - the type of keys
    V - the type of mapped values
    All Implemented Interfaces:
    java.util.Map.Entry<K,​V>, KeyValue<K,​V>
    Direct Known Subclasses:
    DefaultMapEntry, UnmodifiableMapEntry

    public abstract class AbstractMapEntry<K,​V>
    extends AbstractKeyValue<K,​V>
    implements java.util.Map.Entry<K,​V>
    Abstract Pair class to assist with creating correct Map.Entry implementations.
    Since:
    3.0
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected AbstractMapEntry​(K key, V value)
      Constructs a new entry with the given key and given value.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)
      Compares this Map.Entry with another Map.Entry.
      int hashCode()
      Gets a hashCode compatible with the equals method.
      V setValue​(V value)
      Sets the value stored in this Map.Entry.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface java.util.Map.Entry

        getKey, getValue
    • Constructor Detail

      • AbstractMapEntry

        protected AbstractMapEntry​(K key,
                                   V value)
        Constructs a new entry with the given 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

      • setValue

        public V setValue​(V value)
        Sets the value stored in this Map.Entry.

        This Map.Entry is not connected to a Map, so only the local data is changed.

        Specified by:
        setValue in interface java.util.Map.Entry<K,​V>
        Overrides:
        setValue in class AbstractKeyValue<K,​V>
        Parameters:
        value - the new value
        Returns:
        the previous value
      • equals

        public boolean equals​(java.lang.Object obj)
        Compares this Map.Entry with another Map.Entry.

        Implemented per API documentation of Map.Entry.equals(Object)

        Specified by:
        equals in interface java.util.Map.Entry<K,​V>
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the object to compare to
        Returns:
        true if equal key and value
      • hashCode

        public int hashCode()
        Gets a hashCode compatible with the equals method.

        Implemented per API documentation of Map.Entry.hashCode()

        Specified by:
        hashCode in interface java.util.Map.Entry<K,​V>
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        a suitable hash code