DistanceUnit.Distance (elasticsearch-extend 3.2 API)

java.lang.Object
- org.elasticsearch.common.unit.DistanceUnit.Distance

All Implemented Interfaces:

Comparable<DistanceUnit.Distance>

Enclosing class:

DistanceUnit
```
public static class DistanceUnit.Distance
extends Object
implements 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

All Methods Static Methods Instance Methods Concrete Methods
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(Object obj)`
`int`	`hashCode()`
`static DistanceUnit.Distance`	`parseDistance(String distance)`	Parse a `DistanceUnit.Distance` from a given String.
`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(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(DistanceUnit.Distance o)
```
    Specified by:
    
    compareTo in interface Comparable<DistanceUnit.Distance>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - parseDistance
```
public static DistanceUnit.Distance parseDistance(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