Module simpa.core

Package simpa.core.api

Enum Class LengthUnit

java.lang.Object

java.lang.Enum<LengthUnit>

simpa.core.api.LengthUnit

All Implemented Interfaces:

Serializable, Comparable<LengthUnit>, Constable

public enum LengthUnit
extends Enum<LengthUnit>

Enum for LengthUnit and their factor.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CM	Centimeter.
M	Meter.
MM	Millimeter.

Method Summary

Modifier and Type	Method	Description
double	getFactor()	Multiplying by this factor converts it to meters
static LengthUnit	parse(String s)	Parses the length unit as string to the correct enum.
static LengthUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LengthUnit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MM

public static final LengthUnit MM

Millimeter.

CM

public static final LengthUnit CM

Centimeter.

M

public static final LengthUnit M

Meter.

Method Details

values

public static LengthUnit[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static LengthUnit valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

parse

public static LengthUnit parse(String s)

Parses the length unit as string to the correct enum.

Parameters:

s - string version of the length unit (mm, cm, m)

Returns:

the enum for the length unit

getFactor

public double getFactor()

Multiplying by this factor converts it to meters

Returns:

factor