AbstractKeyValue (Commons Collections 4.0-SNAPSHOT API)

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- org.apache.commons.collections.keyvalue.AbstractKeyValue<K,V>

All Implemented Interfaces:

KeyValue<K,V>

Direct Known Subclasses:

AbstractMapEntry, DefaultKeyValue
```
public abstract class AbstractKeyValue<K,V>
extends Object
implements KeyValue<K,V>
```
Abstract pair class to assist with creating KeyValue and Map.Entry implementations.

Since:

3.0

Version:

$Id: AbstractKeyValue.java 1429905 2013-01-07 17:15:14Z ggregory $

Field Summary

Fields
Modifier and Type Field and Description

protected K key
The key

protected V value
The value

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractKeyValue(K key, V value)
Constructs a new pair with the specified key and given value.

Method Summary

Methods
Modifier and Type	Method and Description
`K`	`getKey()` Gets the key from the pair.
`V`	`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 K key
```
    The key
  - value
```
protected V value
```
    The value
- 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
  - toString
```
public String toString()
```
    Gets a debugging String view of the pair.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    a String view of the entry

Prev Class
Next Class

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2001-2013 The Apache Software Foundation. All Rights Reserved.