Package org.elasticsearch.common.unit

Class DistanceUnit.Distance

java.lang.Object

org.elasticsearch.common.unit.DistanceUnit.Distance

All Implemented Interfaces:

java.lang.Comparable<DistanceUnit.Distance>

Enclosing class:

DistanceUnit

public static class DistanceUnit.Distance
extends java.lang.Object
implements java.lang.Comparable<DistanceUnit.Distance>

This class implements a value+unit tuple.

Field Summary

Fields

Modifier and Type	Field	Description
DistanceUnit	unit
double	value

Constructor Summary

Constructors

Constructor	Description
Distance(double value, DistanceUnit unit)

Method Summary

Modifier and Type	Method	Description
int	compareTo(DistanceUnit.Distance o)
DistanceUnit.Distance	convert(DistanceUnit unit)	Converts a DistanceUnit.Distance value given in a specific DistanceUnit into a value equal to the specified value but in a other DistanceUnit.
boolean	equals(java.lang.Object obj)
int	hashCode()
static DistanceUnit.Distance	parseDistance(java.lang.String distance)	Parse a DistanceUnit.Distance from a given String.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

value

public final double value

unit

public final DistanceUnit unit

Constructor Detail

Distance

public Distance(double value,
                DistanceUnit unit)

Method Detail

convert

public DistanceUnit.Distance convert(DistanceUnit unit)

Converts a DistanceUnit.Distance value given in a specific DistanceUnit into a value equal to the specified value but in a other DistanceUnit.

Parameters:

unit - unit of the result

Returns:

converted distance

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(DistanceUnit.Distance o)

Specified by:

compareTo in interface java.lang.Comparable<DistanceUnit.Distance>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

parseDistance

public static DistanceUnit.Distance parseDistance(java.lang.String distance)

Parse a DistanceUnit.Distance from a given String. If no unit is given DistanceUnit.DEFAULT will be used

Parameters:

distance - String defining a DistanceUnit.Distance

Returns:

parsed DistanceUnit.Distance