Package org.apache.commons.collections.keyvalue

Class TiedMapEntry

java.lang.Object
org.apache.commons.collections.keyvalue.TiedMapEntry
All Implemented Interfaces:
Serializable, Map.Entry, KeyValue
@Deprecated(since="2021-04-30") public class TiedMapEntry extends Object implements Map.Entry, KeyValue, Serializable
Deprecated.
Apache Commons Collections version 3.x is being deprecated from AEMaaCS. The upgraded version 4.4 of Commons Collections is already included as replacement. Customers are advised to upgrade to this version of the library. Please note: the package name was changed to org.apache.commons.collections4. Further note that there are AEM APIs currently exposing the old collections classes; these will be updated in upcoming releases.
A Map.Entry tied to a map underneath.

This can be used to enable a map entry to make changes on the underlying map, however this will probably mess up any iterators.

Since:
Commons Collections 3.0
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    TiedMapEntry(Map map, Object key)
    Deprecated.
    Constructs a new entry with the given Map and key.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
    Deprecated.
    Compares this Map.Entry with another Map.Entry.
    Object
    getKey()
    Deprecated.
    Gets the key of this entry
    Object
    getValue()
    Deprecated.
    Gets the value of this entry direct from the map.
    int
    hashCode()
    Deprecated.
    Gets a hashCode compatible with the equals method.
    Object
    setValue(Object value)
    Deprecated.
    Sets the value associated with the key direct onto the map.
    String
    toString()
    Deprecated.
    Gets a string version of the entry.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • TiedMapEntry

      public TiedMapEntry(Map map, Object key)
      Deprecated.
      Constructs a new entry with the given Map and key.
      Parameters:
      map - the map
      key - the key

  • Method Details

    • getKey

      public Object getKey()
      Deprecated.
      Gets the key of this entry
      Specified by:
      getKey in interface KeyValue
      Specified by:
      getKey in interface Map.Entry
      Returns:
      the key

    • getValue

      public Object getValue()
      Deprecated.
      Gets the value of this entry direct from the map.
      Specified by:
      getValue in interface KeyValue
      Specified by:
      getValue in interface Map.Entry
      Returns:
      the value

    • setValue

      public Object setValue(Object value)
      Deprecated.
      Sets the value associated with the key direct onto the map.
      Specified by:
      setValue in interface Map.Entry
      Parameters:
      value - the new value
      Returns:
      the old value
      Throws:
      IllegalArgumentException - if the value is set to this map entry

    • equals

      public boolean equals(Object obj)
      Deprecated.
      Compares this Map.Entry with another Map.Entry.

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

      Specified by:
      equals in interface Map.Entry
      Overrides:
      equals in class Object
      Parameters:
      obj - the object to compare to
      Returns:
      true if equal key and value

    • hashCode

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

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

      Specified by:
      hashCode in interface Map.Entry
      Overrides:
      hashCode in class Object
      Returns:
      a suitable hash code

    • toString

      public String toString()
      Deprecated.
      Gets a string version of the entry.
      Overrides:
      toString in class Object
      Returns:
      entry as a string