com.opengamma.strata.collect.tuple

Class DoublesPair

java.lang.Object

com.opengamma.strata.collect.tuple.DoublesPair

All Implemented Interfaces:

Tuple, Serializable, Comparable<DoublesPair>, org.joda.beans.Bean, org.joda.beans.ImmutableBean

public final class DoublesPair
extends Object
implements org.joda.beans.ImmutableBean, Tuple, Comparable<DoublesPair>, Serializable

An immutable pair consisting of two double elements.

This class is similar to Pair but is based on two primitive double elements.

This class is immutable and thread-safe.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DoublesPair.Meta The meta-bean for DoublesPair.

Method Summary

Modifier and Type	Method and Description
int	compareTo(DoublesPair other) Compares the pair based on the first element followed by the second element.
ImmutableList<Object>	elements() Gets the elements from this pair as a list.
boolean	equals(Object obj)
double	getFirst() Gets the first element in this pair.
double	getSecond() Gets the second element in this pair.
int	hashCode()
static DoublesPair.Meta	meta() The meta-bean for DoublesPair.
DoublesPair.Meta	metaBean()
static DoublesPair	of(double first, double second) Obtains an instance from two double elements.
static DoublesPair	ofPair(Pair<Double,Double> pair) Obtains an instance from a Pair.
static DoublesPair	parse(String pairStr) Parses a DoublesPair from the standard string format.
int	size() Gets the number of elements held by this pair.
Pair<Double,Double>	toPair() Converts this pair to an object-based Pair.
String	toString() Gets the pair using a standard string format.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.joda.beans.Bean

property, propertyNames

Method Detail

of

public static DoublesPair of(double first,
                             double second)

Obtains an instance from two double elements.

Parameters:

first - the first element

second - the second element

Returns:

a pair formed from the two parameters

ofPair

public static DoublesPair ofPair(Pair<Double,Double> pair)

Obtains an instance from a Pair.

Parameters:

pair - the pair to convert

Returns:

a pair formed by extracting values from the pair

parse

public static DoublesPair parse(String pairStr)

Parses a DoublesPair from the standard string format.

The standard format is '[$first, $second]'. Spaces around the values are trimmed.

Parameters:

pairStr - the text to parse

Returns:

the parsed pair

Throws:

IllegalArgumentException - if the pair cannot be parsed

size

public int size()

Gets the number of elements held by this pair.

Specified by:

size in interface Tuple

Returns:

size 2

elements

public ImmutableList<Object> elements()

Gets the elements from this pair as a list.

The list returns each element in the pair in order.

Specified by:

elements in interface Tuple

Returns:

the elements as an immutable list

toPair

public Pair<Double,Double> toPair()

Converts this pair to an object-based Pair.

Returns:

the object-based pair

compareTo

public int compareTo(DoublesPair other)

Compares the pair based on the first element followed by the second element.

Specified by:

compareTo in interface Comparable<DoublesPair>

Parameters:

other - the other pair

Returns:

negative if this is less, zero if equal, positive if greater

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Gets the pair using a standard string format.

The standard format is '[$first, $second]'. Spaces around the values are trimmed.

Overrides:

toString in class Object

Returns:

the pair as a string

meta

public static DoublesPair.Meta meta()

The meta-bean for DoublesPair.

Returns:

the meta-bean, not null

metaBean

public DoublesPair.Meta metaBean()

Specified by:

metaBean in interface org.joda.beans.Bean

getFirst

public double getFirst()

Gets the first element in this pair.

Returns:

the value of the property

getSecond

public double getSecond()

Gets the second element in this pair.

Returns:

the value of the property