Package org.apache.openjpa.lib.util.collections

Class AbstractMapEntryDecorator<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:
    AbstractDualBidiMap.MapEntry
    public abstract class AbstractMapEntryDecorator<K,​V>
extends java.lang.Object
implements java.util.Map.Entry<K,​V>, KeyValue<K,​V>
    Provides a base decorator that allows additional functionality to be added to a Map.Entry.
    Since:
    3.0

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractMapEntryDecorator​(java.util.Map.Entry<K,​V> entry)
      Constructor that wraps (not copies).

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object object)  
      K getKey()
      Gets the key from the pair.
      protected java.util.Map.Entry<K,​V> getMapEntry()
      Gets the map being decorated.
      V getValue()
      Gets the value from the pair.
      int hashCode()  
      V setValue​(V object)  
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • AbstractMapEntryDecorator

        public AbstractMapEntryDecorator​(java.util.Map.Entry<K,​V> entry)
        Constructor that wraps (not copies).
        Parameters:
        entry - the Map.Entry to decorate, must not be null
        Throws:
        java.lang.NullPointerException - if the collection is null

    • Method Detail

      • getMapEntry

        protected java.util.Map.Entry<K,​V> getMapEntry()
        Gets the map being decorated.
        Returns:
        the decorated map

      • getKey

        public K getKey()
        Description copied from interface: KeyValue
        Gets the key from the pair.
        Specified by:
        getKey in interface KeyValue<K,​V>
        Specified by:
        getKey in interface java.util.Map.Entry<K,​V>
        Returns:
        the key

      • getValue

        public V getValue()
        Description copied from interface: KeyValue
        Gets the value from the pair.
        Specified by:
        getValue in interface KeyValue<K,​V>
        Specified by:
        getValue in interface java.util.Map.Entry<K,​V>
        Returns:
        the value

      • setValue

        public V setValue​(V object)
        Specified by:
        setValue in interface java.util.Map.Entry<K,​V>

      • equals

        public boolean equals​(java.lang.Object object)
        Specified by:
        equals in interface java.util.Map.Entry<K,​V>
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface java.util.Map.Entry<K,​V>
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object