org.sbml.jsbml.util

Class ValuePair<L extends java.lang.Comparable<? super L>,V extends java.lang.Comparable<? super V>>

java.lang.Object

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

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

Type Parameters:

L -

V -

All Implemented Interfaces:

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

public class ValuePair<L extends java.lang.Comparable<? super L>,V extends java.lang.Comparable<? super V>>
extends Pair<L,V>
implements java.lang.Comparable<ValuePair<L,V>>

A pair of two values with type parameters. This data object is useful whenever exactly two values are required for a specific task.

Since:

0.8

Author:

Andreas Dräger

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ValuePair() Creates a new ValuePair with both attributes set to null.
ValuePair(L l, V v)
ValuePair(ValuePair<L,V> valuePair)

Method Summary

Modifier and Type	Method and Description
ValuePair<L,V>	clone()
int	compareTo(L l, V v) Convenient method to compare two values to this ValuePair.
int	compareTo(ValuePair<L,V> v)
L	getL()
V	getV()
boolean	isSetL()
boolean	isSetV()
static <L extends java.lang.Comparable<? super L>,V extends java.lang.Comparable<? super V>> ValuePair<L,V>	of(L left, V right) Static method to easily create a value pair of two given values.
void	setL(L l)
void	setV(V v)
static <L extends java.lang.Comparable<? super L>,V extends java.lang.Comparable<? super V>> ValuePair<L,V>	valuePairOf(L left, V right) Can be used for static import, i.e. use import static org.sbml.jsbml.util.ValuePair.pairOf in your class to easily create ValuePairs of arbitrary data types with a simple method call, e.g., valuePairOf(1, 2).

Methods inherited from class org.sbml.jsbml.util.Pair

equals, getKey, getValue, hashCode, isSetKey, isSetValue, pairOf, setKey, setValue, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map.Entry

comparingByKey, comparingByKey, comparingByValue, comparingByValue

Constructor Detail

ValuePair

public ValuePair()

Creates a new ValuePair with both attributes set to null.

ValuePair

public ValuePair(L l,
                 V v)

Parameters:

l -

v -

ValuePair

public ValuePair(ValuePair<L,V> valuePair)

Parameters:

valuePair -

Method Detail

of

public static <L extends java.lang.Comparable<? super L>,V extends java.lang.Comparable<? super V>> ValuePair<L,V> of(L left,
                                                                                                                      V right)

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

Parameters:

left -

right -

Returns:

valuePairOf

public static <L extends java.lang.Comparable<? super L>,V extends java.lang.Comparable<? super V>> ValuePair<L,V> valuePairOf(L left,
                                                                                                                               V right)

Can be used for static import, i.e. use

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

in your class to easily create ValuePairs of arbitrary data types with a simple method call, e.g., valuePairOf(1, 2).

Parameters:

left -

right -

Returns:

clone

public ValuePair<L,V> clone()
                     throws java.lang.CloneNotSupportedException

Throws:

java.lang.CloneNotSupportedException

compareTo

public int compareTo(L l,
                     V v)

Convenient method to compare two values to this ValuePair.

Parameters:

l -

v -

Returns:

a negative integer, zero, or a positive integer as this ValuePair is less than, equal to, or greater than the combination of the two given values.

See Also:

compareTo(ValuePair)

compareTo

public int compareTo(ValuePair<L,V> v)

Specified by:

compareTo in interface java.lang.Comparable<ValuePair<L extends java.lang.Comparable<? super L>,V extends java.lang.Comparable<? super V>>>

getV

public V getV()

Returns:

the v

isSetL

public boolean isSetL()

Returns:

isSetV

public boolean isSetV()

Returns:

setL

public void setL(L l)

Parameters:

l - the l to set

setV

public void setV(V v)

Parameters:

v - the v to set

getL

public L getL()

Returns:

the l