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 aDistanceUnit.Distance
value given in a specificDistanceUnit
into a value equal to the specified value but in a otherDistanceUnit
.boolean
equals(java.lang.Object obj)
int
hashCode()
static DistanceUnit.Distance
parseDistance(java.lang.String distance)
Parse aDistanceUnit.Distance
from a given String.java.lang.String
toString()
-
-
-
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 aDistanceUnit.Distance
value given in a specificDistanceUnit
into a value equal to the specified value but in a otherDistanceUnit
.- Parameters:
unit
- unit of the result- Returns:
- converted distance
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
compareTo
public int compareTo(DistanceUnit.Distance o)
- Specified by:
compareTo
in interfacejava.lang.Comparable<DistanceUnit.Distance>
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
parseDistance
public static DistanceUnit.Distance parseDistance(java.lang.String distance)
Parse aDistanceUnit.Distance
from a given String. If no unit is givenDistanceUnit.DEFAULT
will be used- Parameters:
distance
- String defining aDistanceUnit.Distance
- Returns:
- parsed
DistanceUnit.Distance
-
-