org.mapfish.print.utils

Enum DistanceUnit

java.lang.Object

java.lang.Enum<DistanceUnit>

org.mapfish.print.utils.DistanceUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DistanceUnit>

public enum DistanceUnit
extends java.lang.Enum<DistanceUnit>

An enum for expressing distance units. Contains everything needed for convertions and others.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DistanceUnit.Wrapper

Enum Constant Summary

Enum Constants

Enum Constant and Description
CM
DEGREES
FT
IN
KM
M
MI
MINUTE
MM
PT
SECOND
YD

Method Summary

Methods

Modifier and Type	Method and Description
double	convertTo(double value, DistanceUnit targetUnit) How much is "value" in unit "this" exprimed in the unit "target").
static DistanceUnit	fromString(java.lang.String val)
DistanceUnit[]	getAllUnits()
static DistanceUnit	getBestUnit(double value, DistanceUnit unit) Return the first unit that would give a value >=1
boolean	isBase()
boolean	isSameBaseUnit(DistanceUnit target)
java.lang.String	toString()
static DistanceUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DistanceUnit[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

M

public static final DistanceUnit M

MM

public static final DistanceUnit MM

CM

public static final DistanceUnit CM

KM

public static final DistanceUnit KM

FT

public static final DistanceUnit FT

PT

public static final DistanceUnit PT

IN

public static final DistanceUnit IN

YD

public static final DistanceUnit YD

MI

public static final DistanceUnit MI

DEGREES

public static final DistanceUnit DEGREES

MINUTE

public static final DistanceUnit MINUTE

SECOND

public static final DistanceUnit SECOND

Method Detail

values

public static DistanceUnit[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DistanceUnit c : DistanceUnit.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DistanceUnit valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

isBase

public boolean isBase()

convertTo

public double convertTo(double value,
               DistanceUnit targetUnit)

How much is "value" in unit "this" exprimed in the unit "target"). For example:

 DistanceUnit.M.convertTo(1.0, DistanceUnit.MM)==1000.0
 

isSameBaseUnit

public boolean isSameBaseUnit(DistanceUnit target)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<DistanceUnit>

fromString

public static DistanceUnit fromString(java.lang.String val)

Returns:

null if this unit is unknown

getAllUnits

public DistanceUnit[] getAllUnits()

Returns:

the sorted list (from smallest to biggest) of units sharing the same base unit.

getBestUnit

public static DistanceUnit getBestUnit(double value,
                       DistanceUnit unit)

Return the first unit that would give a value >=1