org.apache.commons.collections.keyvalue

## Class AbstractKeyValue

- java.lang.Object
- - org.apache.commons.collections.keyvalue.AbstractKeyValue

- All Implemented Interfaces:
    KeyValue
  Direct Known Subclasses:
    AbstractMapEntry, DefaultKeyValue

      public abstract class AbstractKeyValue
      extends Object
      implements KeyValue

  Abstract pair class to assist with creating `KeyValue` and `Map.Entry` implementations.
  Since:
    Commons Collections 3.0
  Version:
    $Revision: 646777 $ $Date: 2008-04-10 14:33:15 +0200 (Thu, 10 Apr 2008) $
  Author:
    James Strachan, Michael A. Smith, Neil O'Toole, Stephen Colebourne

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected Object` | `key` The key
    `protected Object` | `value` The value

  - ### Constructor Summary

    Constructors
    Modifier | Constructor and Description
    --- | ---
    `protected` | `AbstractKeyValue(Object key, Object value)` Constructs a new pair with the specified key and given value.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `Object` | `getKey()` Gets the key from the pair.
    `Object` | `getValue()` Gets the value from the pair.
    `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`

- - ### Field Detail

    - #### key

          protected Object key

      The key

    - #### value

          protected Object value

      The value

  - ### Constructor Detail

    - #### AbstractKeyValue

          protected AbstractKeyValue(Object key,
                          Object 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 Object getKey()

      Gets the key from the pair.
      Specified by:
        `getKey` in interface `KeyValue`
      Returns:
        the key

    - #### getValue

          public Object getValue()

      Gets the value from the pair.
      Specified by:
        `getValue` in interface `KeyValue`
      Returns:
        the value

    - #### toString

          public String toString()

      Gets a debugging String view of the pair.
      Overrides:
        `toString` in class `Object`
      Returns:
        a String view of the entry

Copyright © 2001–2015 The Apache Software Foundation. All rights reserved.