Distance

java.lang.Object
- lumis.portal.bigdata.query.Distance

@StableMinor(version="17.0",
             sinceVersion="9.0")
public class Distance
extends java.lang.Object

Represents a distance with an amount and a distance unit.

Since:: 9.0.0
Version:: $Revision$ $Date$

Constructor Summary

Constructors
Constructor Description

Distance(double amount, DistanceUnit unit)
Creates a new distance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`getAmount()`	Returns the amount.
`DistanceUnit`	`getUnit()`	Returns the unit.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Distance
```
public Distance(double amount,
                DistanceUnit unit)
```
    Creates a new distance.
    
    Parameters:
    
    amount - the amount of the distance. Must be a non-negative non-infinity number.
    
    unit - the distance unit. Must not be null.
    
    Since:
    
    9.0.0
- Method Detail
  - getAmount
```
public double getAmount()
```
    Returns the amount.
    
    Returns:
    
    the amount
    
    Since:
    
    9.0.0
  - getUnit
```
public DistanceUnit getUnit()
```
    Returns the unit.
    
    Returns:
    
    the unit
    
    Since:
    
    9.0.0
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object