io.jenetics.jpx

Class Length

java.lang.Object

java.lang.Number

io.jenetics.jpx.Length

All Implemented Interfaces:

Serializable, Comparable<Length>

public final class Length
extends Number
implements Comparable<Length>, Serializable

Extent of something along its greatest dimension or the extent of space between two objects or places. The metric system unit for this quantity is "m" (metre).

Since:

1.0

Version:

1.0

Author:

Franz Wilhelmstötter

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Length.Unit Represents a given length unit.

Method Summary

Modifier and Type	Method and Description
int	compareTo(Length other)
double	doubleValue() Return the length in meter.
boolean	equals(Object obj)
float	floatValue()
int	hashCode()
int	intValue()
long	longValue()
static Length	of(double length, Length.Unit unit) Create a new Length object with the given length.
double	to(Length.Unit unit) Return the length in the desired unit.
String	toString()

Methods inherited from class java.lang.Number

byteValue, shortValue

Methods inherited from class java.lang.Object

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

Method Detail

doubleValue

public double doubleValue()

Return the length in meter.

Specified by:

doubleValue in class Number

Returns:

the length in meter

to

public double to(Length.Unit unit)

Return the length in the desired unit.

Parameters:

unit - the desired length unit

Returns:

the length in the desired unit

Throws:

NullPointerException - if the given length unit is null

intValue

public int intValue()

Specified by:

intValue in class Number

longValue

public long longValue()

Specified by:

longValue in class Number

floatValue

public float floatValue()

Specified by:

floatValue in class Number

compareTo

public int compareTo(Length other)

Specified by:

compareTo in interface Comparable<Length>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

of

public static Length of(double length,
                        Length.Unit unit)

Create a new Length object with the given length.

Parameters:

length - the length

unit - the length unit

Returns:

a new Length object with the given length.

Throws:

NullPointerException - if the given length unit is null