Distance (SweetBlue)

java.lang.Object
- com.idevicesinc.sweetblue.utils.Unit<Distance>
- - com.idevicesinc.sweetblue.utils.Distance

```
public class Distance
extends Unit<Distance>
```
Wrapper for a positive-only physical distance supporting various units of measurement.

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`FEET_PER_METER`
`static Distance`	`INVALID` Convenience value representing an invalid/impossible distance, arbitrarily chosen to be negative one meter.
`static Distance`	`ZERO` Convenience value for zero meters.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`feet()` Returns the value of this distance in feet.
`static Distance`	`feet(double feet)` Creates a new value in feet.
`protected double`	`getRawValue()` Subclasses must implement this to return their raw `double` value.
`boolean`	`isValid()` Returns `true` if `meters()` is >= 0.
`double`	`meters()` Returns the value of this distance in meters.
`static Distance`	`meters(double meters)` Creates a new value in meters.
`protected Unit<Distance>`	`newInstance(double rawValue)` Subclasses must override this so that arithmetic "operators" can create new instances.
`String`	`toString()`

Methods inherited from class com.idevicesinc.sweetblue.utils.Unit
dividedBy, equals, gt, gt, gte, gte, hashCode, lt, lt, lte, lte, minus, plus, times

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

- Field Detail
  - FEET_PER_METER
```
public static final double FEET_PER_METER
```
    See Also:
    
    Constant Field Values
  - ZERO
```
public static final Distance ZERO
```
    Convenience value for zero meters.
  - INVALID
```
public static final Distance INVALID
```
    Convenience value representing an invalid/impossible distance, arbitrarily chosen to be negative one meter.
- Method Detail
  - meters
```
public double meters()
```
    Returns the value of this distance in meters.
  - feet
```
public double feet()
```
    Returns the value of this distance in feet.
  - meters
```
public static Distance meters(double meters)
```
    Creates a new value in meters.
  - feet
```
public static Distance feet(double feet)
```
    Creates a new value in feet.
  - isValid
```
public boolean isValid()
```
    Returns true if meters() is >= 0.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getRawValue
```
protected double getRawValue()
```
    Description copied from class: Unit
    
    Subclasses must implement this to return their raw double value.
    
    Specified by:
    
    getRawValue in class Unit<Distance>
  - newInstance
```
protected Unit<Distance> newInstance(double rawValue)
```
    Description copied from class: Unit
    
    Subclasses must override this so that arithmetic "operators" can create new instances.
    
    Specified by:
    
    newInstance in class Unit<Distance>

Class Distance

Field Summary

Method Summary

Methods inherited from class com.idevicesinc.sweetblue.utils.Unit

Methods inherited from class java.lang.Object

Field Detail

FEET_PER_METER

ZERO

INVALID

Method Detail

meters

feet

meters

feet

isValid

toString

getRawValue

newInstance