Package com.irurueta.units

Enum Class TemperatureUnit

java.lang.Object

java.lang.Enum<TemperatureUnit>

com.irurueta.units.TemperatureUnit

All Implemented Interfaces:

Serializable, Comparable<TemperatureUnit>, Constable

public enum TemperatureUnit
extends Enum<TemperatureUnit>

Enumerator containing recognized typical temperature units.

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
CELSIUS	Celsius (ºC).
FAHRENHEIT	Fahrenheit (ºF).
KELVIN	Kelvin (K).

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TemperatureUnit()

Method Summary

Modifier and Type	Method	Description
static TemperatureUnit[]	getImperialUnits()	Gets all supported imperial temperature units.
static TemperatureUnit[]	getMetricUnits()	Gets all supported metric temperature units.
static UnitSystem	getUnitSystem(TemperatureUnit unit)	Returns unit system for provided temperature unit.
static boolean	isImperial(TemperatureUnit unit)	Indicates whether provided unit belongs to the imperial unit system.
static boolean	isMetric(TemperatureUnit unit)	Indicates whether provided unit belongs to the metric unit system.
static TemperatureUnit	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TemperatureUnit[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CELSIUS

public static final TemperatureUnit CELSIUS

Celsius (ºC).

FAHRENHEIT

public static final TemperatureUnit FAHRENHEIT

Fahrenheit (ºF).

KELVIN

public static final TemperatureUnit KELVIN

Kelvin (K).

Constructor Details

TemperatureUnit

private TemperatureUnit()

Method Details

values

public static TemperatureUnit[] 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 TemperatureUnit 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

getUnitSystem

public static UnitSystem getUnitSystem(TemperatureUnit unit)

Returns unit system for provided temperature unit.

Parameters:

unit - temperature unit to be checked.

Returns:

unit system (metric or imperial).

Throws:

IllegalArgumentException - if unit is null or not supported.

getMetricUnits

public static TemperatureUnit[] getMetricUnits()

Gets all supported metric temperature units.

Returns:

all supported metric temperature units.

getImperialUnits

public static TemperatureUnit[] getImperialUnits()

Gets all supported imperial temperature units.

Returns:

all supported imperial temperature units.

isMetric

public static boolean isMetric(TemperatureUnit unit)

Indicates whether provided unit belongs to the metric unit system.

Parameters:

unit - temperature unit to be checked.

Returns:

true if unit belongs to metric unit system.

Throws:

IllegalArgumentException - if unit is null or not supported.

isImperial

public static boolean isImperial(TemperatureUnit unit)

Indicates whether provided unit belongs to the imperial unit system.

Parameters:

unit - temperature unit to be checked.

Returns:

true if unit belongs to imperial unit system.

Throws:

IllegalArgumentException - if unit is null or not supported.