org.incava.ijdk.lang

Class KeyValue<K,V>

java.lang.Object

org.incava.ijdk.lang.KeyValue<K,V>

All Implemented Interfaces:

java.lang.Comparable<KeyValue<K,V>>

Direct Known Subclasses:

Pair

public class KeyValue<K,V>
extends java.lang.Object
implements java.lang.Comparable<KeyValue<K,V>>

Otherwise known as a Pair. This class, unlike org.incava.ijdk.lang.Pair, does not require that the key and value types be Comparable, using their compareTo methods in KeyValue#compareTo if they are subclasses of Comparable.

Constructor Summary

Constructors

Constructor and Description
KeyValue(K key, V value) Constructs a KeyValue.

Method Summary

Modifier and Type	Method and Description
int	compareTo(KeyValue<K,V> other) Compares the given object to this one, using their compareTo methods if the key and/or value implement Comparable.
boolean	equals(java.lang.Object obj) Returns if obj equals this one.
K	getKey() Returns the key.
V	getValue() Returns the value.
int	hashCode() Returns the hash code for the key/value pair.
K	key() Returns the key.
static <K,V> KeyValue<K,V>	of(K key, V value) Shorter syntax than the default constructor, allowing the compiler to discern the object types.
java.lang.String	toString() Returns this key/value pair as a string, in the form "#{key} => #{value}".
java.lang.String	toString(java.lang.String sep) Returns this key/value pair as a string, using the given separator, in the form "#{key}#{separator}#{value}".
V	value() Returns the value.

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyValue

public KeyValue(K key,
                V value)

Constructs a KeyValue. Either key or value can be null.

Parameters:

key - the key

value - the value

Method Detail

of

public static <K,V> KeyValue<K,V> of(K key,
                                     V value)

Shorter syntax than the default constructor, allowing the compiler to discern the object types.

Parameters:

key - the key

value - the value

Returns:

a new KeyValue pair

getKey

public K getKey()

Returns the key.

Returns:

the key

getValue

public V getValue()

Returns the value.

Returns:

the value

key

public K key()

Returns the key.

Returns:

the key

value

public V value()

Returns the value.

Returns:

the value

equals

public boolean equals(java.lang.Object obj)

Returns if obj equals this one.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to compare to this one

Returns:

if obj equals this one

toString

public java.lang.String toString()

Returns this key/value pair as a string, in the form "#{key} => #{value}".

Overrides:

toString in class java.lang.Object

Returns:

this object as a string

toString

public java.lang.String toString(java.lang.String sep)

Returns this key/value pair as a string, using the given separator, in the form "#{key}#{separator}#{value}".

Parameters:

sep - the separator to use

Returns:

this object as a string

hashCode

public int hashCode()

Returns the hash code for the key/value pair.

Overrides:

hashCode in class java.lang.Object

Returns:

the hash code

compareTo

public int compareTo(KeyValue<K,V> other)

Compares the given object to this one, using their compareTo methods if the key and/or value implement Comparable.

Specified by:

compareTo in interface java.lang.Comparable<KeyValue<K,V>>

Parameters:

other - the KeyValue to compare to this one

Returns:

the comparison value, which is -1, 0, or 1