javax.measure

Enum MetricPrefix

java.lang.Object

java.lang.Enum<MetricPrefix>

javax.measure.MetricPrefix

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MetricPrefix>, Prefix

public enum MetricPrefix
extends java.lang.Enum<MetricPrefix>
implements Prefix

This class provides support for the 20 prefixes used in the metric system (decimal multiples and submultiples of units). For example:

 
     import static tech.units.indriya.unit.Units.*;  // Static import.
     import static javax.measure.MetricPrefix.*; // Static import.
     import javax.measure.*;
     import javax.measure.quantity.*;
     ...
     Unit HECTOPASCAL = HECTO(PASCAL);
     Unit KILOMETRE = KILO(METRE);
     
 

Since:

2.0

Version:

1.9, 2018-08-08

Author:

Jean-Marie Dautelle, Werner Keil

See Also:

Wikipedia: Metric Prefix

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATTO
CENTI
DECI
DEKA
EXA
FEMTO
GIGA
HECTO
KILO
MEGA
MICRO
MILLI
NANO
PETA
PICO
TERA
YOCTO
YOTTA
ZEPTO
ZETTA

Method Summary

Modifier and Type	Method and Description
static <Q extends Quantity<Q>> Unit<Q>	ATTO(Unit<Q> unit) Returns the specified unit multiplied by the factor 10-18
static <Q extends Quantity<Q>> Unit<Q>	CENTI(Unit<Q> unit) Returns the specified unit multiplied by the factor 10-2
static <Q extends Quantity<Q>> Unit<Q>	DECI(Unit<Q> unit) Returns the specified unit multiplied by the factor 10-1
static <Q extends Quantity<Q>> Unit<Q>	DEKA(Unit<Q> unit) Returns the specified unit multiplied by the factor 101
static <Q extends Quantity<Q>> Unit<Q>	EXA(Unit<Q> unit) Returns the specified unit multiplied by the factor 1018
static <Q extends Quantity<Q>> Unit<Q>	FEMTO(Unit<Q> unit) Returns the specified unit multiplied by the factor 10-15
int	getBase() Base part of the associated factor in base^exponent representation.
int	getExponent() Exponent part of the associated factor in base^exponent representation.
java.lang.String	getName() Returns the name of this prefix.
java.lang.String	getSymbol() Returns the symbol of this prefix.
static <Q extends Quantity<Q>> Unit<Q>	GIGA(Unit<Q> unit) Returns the specified unit multiplied by the factor 109
static <Q extends Quantity<Q>> Unit<Q>	HECTO(Unit<Q> unit) Returns the specified unit multiplied by the factor 102
static <Q extends Quantity<Q>> Unit<Q>	KILO(Unit<Q> unit) Returns the specified unit multiplied by the factor 103
static <Q extends Quantity<Q>> Unit<Q>	MEGA(Unit<Q> unit) Returns the specified unit multiplied by the factor 106
static <Q extends Quantity<Q>> Unit<Q>	MICRO(Unit<Q> unit) Returns the specified unit multiplied by the factor 10-6
static <Q extends Quantity<Q>> Unit<Q>	MILLI(Unit<Q> unit) Returns the specified unit multiplied by the factor 10-3
static <Q extends Quantity<Q>> Unit<Q>	NANO(Unit<Q> unit) Returns the specified unit multiplied by the factor 10-9
static <Q extends Quantity<Q>> Unit<Q>	PETA(Unit<Q> unit) Returns the specified unit multiplied by the factor 1015
static <Q extends Quantity<Q>> Unit<Q>	PICO(Unit<Q> unit) Returns the specified unit multiplied by the factor 10-12
static <Q extends Quantity<Q>> Unit<Q>	TERA(Unit<Q> unit) Returns the specified unit multiplied by the factor 1012
static MetricPrefix	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MetricPrefix[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static <Q extends Quantity<Q>> Unit<Q>	YOCTO(Unit<Q> unit) Returns the specified unit multiplied by the factor 10-24
static <Q extends Quantity<Q>> Unit<Q>	YOTTA(Unit<Q> unit) Returns the specified unit multiplied by the factor 1024
static <Q extends Quantity<Q>> Unit<Q>	ZEPTO(Unit<Q> unit) Returns the specified unit multiplied by the factor 10-21
static <Q extends Quantity<Q>> Unit<Q>	ZETTA(Unit<Q> unit) Returns the specified unit multiplied by the factor 1021

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

YOTTA

public static final MetricPrefix YOTTA

ZETTA

public static final MetricPrefix ZETTA

EXA

public static final MetricPrefix EXA

PETA

public static final MetricPrefix PETA

TERA

public static final MetricPrefix TERA

GIGA

public static final MetricPrefix GIGA

MEGA

public static final MetricPrefix MEGA

KILO

public static final MetricPrefix KILO

HECTO

public static final MetricPrefix HECTO

DEKA

public static final MetricPrefix DEKA

DECI

public static final MetricPrefix DECI

CENTI

public static final MetricPrefix CENTI

MILLI

public static final MetricPrefix MILLI

MICRO

public static final MetricPrefix MICRO

NANO

public static final MetricPrefix NANO

PICO

public static final MetricPrefix PICO

FEMTO

public static final MetricPrefix FEMTO

ATTO

public static final MetricPrefix ATTO

ZEPTO

public static final MetricPrefix ZEPTO

YOCTO

public static final MetricPrefix YOCTO

Method Detail

values

public static MetricPrefix[] 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 (MetricPrefix c : MetricPrefix.values())
    System.out.println(c);

Returns:

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

valueOf

public static MetricPrefix 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

YOTTA

public static <Q extends Quantity<Q>> Unit<Q> YOTTA(Unit<Q> unit)

Returns the specified unit multiplied by the factor 1024

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e24).

ZETTA

public static <Q extends Quantity<Q>> Unit<Q> ZETTA(Unit<Q> unit)

Returns the specified unit multiplied by the factor 1021

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e21).

EXA

public static <Q extends Quantity<Q>> Unit<Q> EXA(Unit<Q> unit)

Returns the specified unit multiplied by the factor 1018

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e18).

PETA

public static <Q extends Quantity<Q>> Unit<Q> PETA(Unit<Q> unit)

Returns the specified unit multiplied by the factor 1015

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e15).

TERA

public static <Q extends Quantity<Q>> Unit<Q> TERA(Unit<Q> unit)

Returns the specified unit multiplied by the factor 1012

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e12).

GIGA

public static <Q extends Quantity<Q>> Unit<Q> GIGA(Unit<Q> unit)

Returns the specified unit multiplied by the factor 109

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e9).

MEGA

public static <Q extends Quantity<Q>> Unit<Q> MEGA(Unit<Q> unit)

Returns the specified unit multiplied by the factor 106

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e6).

KILO

public static <Q extends Quantity<Q>> Unit<Q> KILO(Unit<Q> unit)

Returns the specified unit multiplied by the factor 103

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e3).

HECTO

public static <Q extends Quantity<Q>> Unit<Q> HECTO(Unit<Q> unit)

Returns the specified unit multiplied by the factor 102

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e2).

DEKA

public static <Q extends Quantity<Q>> Unit<Q> DEKA(Unit<Q> unit)

Returns the specified unit multiplied by the factor 101

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e1).

DECI

public static <Q extends Quantity<Q>> Unit<Q> DECI(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10-1

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e-1).

CENTI

public static <Q extends Quantity<Q>> Unit<Q> CENTI(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10-2

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e-2).

MILLI

public static <Q extends Quantity<Q>> Unit<Q> MILLI(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10-3

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e-3).

MICRO

public static <Q extends Quantity<Q>> Unit<Q> MICRO(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10-6

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e-6).

NANO

public static <Q extends Quantity<Q>> Unit<Q> NANO(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10-9

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e-9).

PICO

public static <Q extends Quantity<Q>> Unit<Q> PICO(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10-12

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e-12).

FEMTO

public static <Q extends Quantity<Q>> Unit<Q> FEMTO(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10-15

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e-15).

ATTO

public static <Q extends Quantity<Q>> Unit<Q> ATTO(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10-18

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e-18).

ZEPTO

public static <Q extends Quantity<Q>> Unit<Q> ZEPTO(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10-21

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e-21).

YOCTO

public static <Q extends Quantity<Q>> Unit<Q> YOCTO(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10-24

Type Parameters:

Q - The type of the quantity measured by the unit.

Parameters:

unit - any unit.

Returns:

unit.times(1e-24).

getSymbol

public java.lang.String getSymbol()

Returns the symbol of this prefix.

Specified by:

getSymbol in interface Prefix

Returns:

this prefix symbol, not null.

getBase

public int getBase()

Base part of the associated factor in base^exponent representation.

Specified by:

getBase in interface Prefix

Returns:

the base part of this prefix.

getExponent

public int getExponent()

Exponent part of the associated factor in base^exponent representation.

Specified by:

getExponent in interface Prefix

Returns:

the exponent part of this prefix.

getName

public java.lang.String getName()

Returns the name of this prefix.

Specified by:

getName in interface Prefix

Returns:

this prefix name, not null.