org.sbml.jsbml.util

Class Pair<L,V>

java.lang.Object

org.sbml.jsbml.util.Pair<L,V>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map.Entry<L,V>

Direct Known Subclasses:

ValuePair

public class Pair<L,V>
extends java.lang.Object
implements java.lang.Cloneable, java.util.Map.Entry<L,V>, java.io.Serializable

A general implementation of a 2-tuple, i.e., two arbitrary objects.

Since:

1.0

Version:

$Rev: 1686 $

Author:

Andreas Dräger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private L	l Left value.
private static long	serialVersionUID Generated serial version identifier.
private V	v Right value.

Constructor Summary

Constructors

Constructor and Description
Pair()
Pair(L l, V v)
Pair(Pair<L,V> pair)

Method Summary

Methods

Modifier and Type	Method and Description
protected java.lang.Object	clone()
boolean	equals(java.lang.Object object)
L	getKey()
V	getValue()
int	hashCode()
boolean	isSetKey()
boolean	isSetValue()
static <L,V> Pair<L,V>	of(L left, V right) Static method to easily create a value pair of two given values.
static <L,V> Pair<L,V>	pairOf(L left, V right) Can be used for static import in your class to easily create Pairs of arbitrary data types with a simple method call, e.g., pairOf(1, 2).
L	setKey(L l)
V	setValue(V value)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Generated serial version identifier.

See Also:

Constant Field Values

l

private L l

Left value.

v

private V v

Right value.

Constructor Detail

Pair

public Pair()

Pair

public Pair(L l,
    V v)

Parameters:

l -

v -

Pair

public Pair(Pair<L,V> pair)

Parameters:

pair -

Method Detail

of

public static <L,V> Pair<L,V> of(L left,
                 V right)

Static method to easily create a value pair of two given values.

Parameters:

left -

right -

Returns:

pairOf

public static <L,V> Pair<L,V> pairOf(L left,
                     V right)

Can be used for static import in your class to easily create Pairs of arbitrary data types with a simple method call, e.g., pairOf(1, 2). This means, you can use

 import static org.sbml.jsbml.util.Pair.pairOf
 

Parameters:

left -

right -

Returns:

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map.Entry<L,V>

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Specified by:

equals in interface java.util.Map.Entry<L,V>

Overrides:

equals in class java.lang.Object

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

setKey

public L setKey(L l)

getKey

public L getKey()

Specified by:

getKey in interface java.util.Map.Entry<L,V>

getValue

public V getValue()

Specified by:

getValue in interface java.util.Map.Entry<L,V>

setValue

public V setValue(V value)

Specified by:

setValue in interface java.util.Map.Entry<L,V>

isSetKey

public boolean isSetKey()

Returns:

isSetValue

public boolean isSetValue()

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object