Class LengthUnit

java.lang.Object

de.xima.fc.common.measure.LengthUnit

All Implemented Interfaces:

Length, MeasurementUnit<Length>

public final class LengthUnit
extends Object
implements Length

Common units of length.

Since:

8.4.0

Field Summary

Fields

Modifier and Type	Field	Description
static final Length	CENTIMETER	A centimeter
static final Length	CM	A centimeter
static final Length	DECIMETER	A decimeter
static final Length	DM	A decimeter
static final Length	INCH	An inch (2.54cm)
static final Length	KILOMETER	A kilometer
static final Length	KM	A kilometer
static final Length	M	A meter
static final Length	METER	A meter
static final Length	MICROMETER	A micrometer
static final Length	MILLIMETER	A millimeter
static final Length	MM	A millimeter
static final Length	NANOMETER	A nanometer
static final Length	NM	A nanometer
static final Length	PIXEL	A pixel. 1px = 1/96th of 1 inch.
static final Length	POINT	A pixel. 1pt = 1/72th of 1 inch.
static final Length	PT	A pixel. 1pt = 1/72th of 1 inch.
static final Length	PX	A pixel. 1px = 1/96th of 1 inch.
static final Length	UM	A micrometer

Fields inherited from interface Length

REFERENCE

Method Summary

Modifier and Type	Method	Description
long	conversionFactorDenominator()	The denominator of the fraction representing the conversion factor from this unit to the reference unit.
long	conversionFactorNumerator()	The numerator of the fraction representing the conversion factor from this unit to the reference unit.
boolean	equals(Object obj)
int	hashCode()
final QuantityDouble<Length>	of(double value)	Creates a new QuantityDouble that uses double object with the specified value in this unit.
QuantityBigDecimal<Length>	of(BigDecimal value)	Creates a new QuantityBigDecimal that uses big decimal object with the specified value in this unit.
protected Length	self()
String	symbol()	The reference unit of this measurement unit.
String	toString()	Gets a string representation of the unit, usually the unit symbol such as "m" for meters or "kg" for kilograms.

Methods inherited from class Object

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

Methods inherited from interface MeasurementUnit

conversionFactorDenominator, conversionFactorNumerator, of, of, symbol, toString

Field Details

CENTIMETER

public static final Length CENTIMETER

A centimeter

CM

public static final Length CM

A centimeter

DECIMETER

public static final Length DECIMETER

A decimeter

DM

public static final Length DM

A decimeter

INCH

public static final Length INCH

An inch (2.54cm)

KILOMETER

public static final Length KILOMETER

A kilometer

KM

public static final Length KM

A kilometer

M

public static final Length M

A meter

METER

public static final Length METER

A meter

MICROMETER

public static final Length MICROMETER

A micrometer

MILLIMETER

public static final Length MILLIMETER

A millimeter

MM

public static final Length MM

A millimeter

NANOMETER

public static final Length NANOMETER

A nanometer

NM

public static final Length NM

A nanometer

PIXEL

public static final Length PIXEL

A pixel. 1px = 1/96th of 1 inch.

POINT

public static final Length POINT

A pixel. 1pt = 1/72th of 1 inch.

PT

public static final Length PT

A pixel. 1pt = 1/72th of 1 inch.

PX

public static final Length PX

A pixel. 1px = 1/96th of 1 inch.

UM

public static final Length UM

A micrometer

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

self

protected Length self()

conversionFactorDenominator

public long conversionFactorDenominator()

Description copied from interface: MeasurementUnit

The denominator of the fraction representing the conversion factor from this unit to the reference unit.

Specified by:

conversionFactorDenominator in interface MeasurementUnit<Self extends MeasurementUnit<Self>>

Returns:

The conversion factor denominator.

conversionFactorNumerator

public long conversionFactorNumerator()

Description copied from interface: MeasurementUnit

The numerator of the fraction representing the conversion factor from this unit to the reference unit.

Specified by:

conversionFactorNumerator in interface MeasurementUnit<Self extends MeasurementUnit<Self>>

Returns:

The conversion factor numerator.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

of

public final QuantityDouble<Length> of(double value)

Description copied from interface: MeasurementUnit

Creates a new QuantityDouble that uses double object with the specified value in this unit.

Specified by:

of in interface MeasurementUnit<Self extends MeasurementUnit<Self>>

Parameters:

value - The value in this unit.

Returns:

A new QuantityDouble object with the specified value in this unit.

of

public QuantityBigDecimal<Length> of(BigDecimal value)

Description copied from interface: MeasurementUnit

Creates a new QuantityBigDecimal that uses big decimal object with the specified value in this unit.

Specified by:

of in interface MeasurementUnit<Self extends MeasurementUnit<Self>>

Parameters:

value - The value in this unit.

Returns:

A new QuantityBigDecimal object with the specified value in this unit.

symbol

public String symbol()

Description copied from interface: MeasurementUnit

The reference unit of this measurement unit. Also serves as a unique identifier for the unit.

Specified by:

symbol in interface MeasurementUnit<Self extends MeasurementUnit<Self>>

Returns:

The unit symbol.

toString

public String toString()

Description copied from interface: MeasurementUnit

Gets a string representation of the unit, usually the unit symbol such as "m" for meters or "kg" for kilograms.

Specified by:

toString in interface MeasurementUnit<Self extends MeasurementUnit<Self>>

Overrides:

toString in class Object

Returns:

The reference unit.