Package ch.tocco.nice2.toolbox.api.util

Class Distance

java.lang.Object

ch.tocco.nice2.toolbox.api.util.Distance

All Implemented Interfaces:

Serializable

public class Distance
extends Object
implements Serializable

Holds distances normalized to km offering some convenience access methods.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Distance.Unit

Constructor Summary

Constructors

Constructor	Description
Distance(BigDecimal km)	Constructs a distance with the given argument interpreted as KM.

Method Summary

Modifier and Type	Method	Description
Distance	abs()
Distance	add(Distance dst)	Returns the sum of this distance and the argument.
Distance	avg(Distance dst)	Returns the average of this distance and the argument.
static Distance	centimeter(String cm)
int	compareTo(Distance o)
boolean	equals(Object obj)
double	getCm()
double	getKm()
double	getMeter()
BigDecimal	getValue()
int	hashCode()
static Distance	kilometer(String km)
static Distance	meter(String m)
Distance	mult(BigDecimal factor)
static Distance	parse(String dst)	Parses a distance string given as
static Distance	parse(String dst, @Nullable Distance.Unit fallback)
String	serialize()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

Distance

public Distance(BigDecimal km)

Constructs a distance with the given argument interpreted as KM.

Method Details

getValue

public BigDecimal getValue()

getKm

public double getKm()

getMeter

public double getMeter()

getCm

public double getCm()

meter

public static Distance meter(String m)

kilometer

public static Distance kilometer(String km)

centimeter

public static Distance centimeter(String cm)

add

public Distance add(Distance dst)

Returns the sum of this distance and the argument.

avg

public Distance avg(Distance dst)

Returns the average of this distance and the argument.

mult

public Distance mult(BigDecimal factor)

abs

public Distance abs()

parse

public static Distance parse(String dst)

Parses a distance string given as

   <number>[km|m|cm]
 

parse

public static Distance parse(String dst,
 @Nullable
 @Nullable Distance.Unit fallback)

compareTo

public int compareTo(Distance o)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

serialize

public String serialize()