java.lang.Object

java.lang.Enum<MetricPrefix>

javax.measure.MetricPrefix

All Implemented Interfaces:: Serializable, Comparable<MetricPrefix>, java.lang.constant.Constable, Prefix

public enum MetricPrefix extends Enum<MetricPrefix> implements Prefix

Provides support for the 24 prefixes used in the metric system (decimal multiples and submultiples of units). For example:

 import static tech.units.indriya.unit.Units.*;  // Static import (from the RI).
 import static javax.measure.MetricPrefix.*; // Static import.
 import javax.measure.*;
 import javax.measure.quantity.*;
 ...
 Unit<Pressure> HECTOPASCAL = HECTO(PASCAL);
 Unit<Length> KILOMETRE = KILO(METRE);

You could also apply Unit.prefix:

 ...
 Unit<Pressure> HECTOPASCAL = PASCAL.prefix(HECTO);
 Unit<Length> KILOMETRE = METRE.prefix(KILO);

Do not use ordinal() to obtain the numeric representation of MetricPrefix. Use getValue() and getExponent() instead.

Implementation Requirements: This is an immutable and thread-safe enum.

Since:

2.0

Version:

2.3, May 20, 2023

Author:

Jean-Marie Dautelle, Werner Keil

See Also:

Wikipedia: Metric Prefix

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

ATTO

Prefix for 10^-18.

CENTI

Prefix for 10^-2.

DECA

Prefix for 10¹.

DECI

Prefix for 10^-1.

EXA

Prefix for 10¹⁸.

FEMTO

Prefix for 10^-15.

GIGA

Prefix for 10⁹.

HECTO

Prefix for 10².

KILO

Prefix for 10³.

MEGA

Prefix for 10⁶.

MICRO

Prefix for 10^-6.

MILLI

Prefix for 10^-3.

NANO

Prefix for 10^-9.

PETA

Prefix for 10¹⁵.

PICO

Prefix for 10^-12.

QUECTO

Prefix for 10^-30.

QUETTA

Prefix for 10³⁰.

RONNA

Prefix for 10²⁷.

RONTO

Prefix for 10^-27.

TERA

Prefix for 10¹².

YOCTO

Prefix for 10^-24.

YOTTA

Prefix for 10²⁴.

ZEPTO

Prefix for 10^-21.

ZETTA

Prefix for 10²¹.
Method Summary

Modifier and Type

Method

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>

DECA(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10¹

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)

US alias for DECA.

static <Q extends Quantity<Q>> Unit<Q>

EXA(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10¹⁸

static <Q extends Quantity<Q>> Unit<Q>

FEMTO(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10^-15

int

getExponent()

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

String

getName()

Returns the name of this prefix.

String

getSymbol()

Returns the symbol of this prefix.

Integer

getValue()

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

static <Q extends Quantity<Q>> Unit<Q>

GIGA(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10⁹

static <Q extends Quantity<Q>> Unit<Q>

HECTO(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10²

static <Q extends Quantity<Q>> Unit<Q>

KILO(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10³

static <Q extends Quantity<Q>> Unit<Q>

MEGA(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10⁶

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 10¹⁵

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>

QUECTO(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10^-30

static <Q extends Quantity<Q>> Unit<Q>

QUETTA(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10³⁰

static <Q extends Quantity<Q>> Unit<Q>

RONNA(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10²⁷

static <Q extends Quantity<Q>> Unit<Q>

RONTO(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10^-27

static <Q extends Quantity<Q>> Unit<Q>

TERA(Unit<Q> unit)

Returns the specified unit multiplied by the factor 10¹²

static MetricPrefix

valueOf(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 10²⁴

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 10²¹

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
- QUETTA
  
  public static final MetricPrefix QUETTA
  
  Prefix for 10³⁰.
- RONNA
  
  public static final MetricPrefix RONNA
  
  Prefix for 10²⁷.
- YOTTA
  
  public static final MetricPrefix YOTTA
  
  Prefix for 10²⁴.
- ZETTA
  
  public static final MetricPrefix ZETTA
  
  Prefix for 10²¹.
- EXA
  
  public static final MetricPrefix EXA
  
  Prefix for 10¹⁸.
- PETA
  
  public static final MetricPrefix PETA
  
  Prefix for 10¹⁵.
- TERA
  
  public static final MetricPrefix TERA
  
  Prefix for 10¹².
- GIGA
  
  public static final MetricPrefix GIGA
  
  Prefix for 10⁹.
  See Also:
  
  Wikipedia: Giga
- MEGA
  
  public static final MetricPrefix MEGA
  
  Prefix for 10⁶.
  See Also:
  
  Wikipedia: Mega
- KILO
  
  public static final MetricPrefix KILO
  
  Prefix for 10³.
  See Also:
  
  Wikipedia: Kilo
- HECTO
  
  public static final MetricPrefix HECTO
  
  Prefix for 10².
  See Also:
  
  Wikipedia: Hecto
- DECA
  
  public static final MetricPrefix DECA
  
  Prefix for 10¹.
  See Also:
  
  Wikipedia: Deca
- DECI
  
  public static final MetricPrefix DECI
  
  Prefix for 10^-1.
  See Also:
  
  Wikipedia: Deci
- CENTI
  
  public static final MetricPrefix CENTI
  
  Prefix for 10^-2.
  See Also:
  
  Wikipedia: Centi
- MILLI
  
  public static final MetricPrefix MILLI
  
  Prefix for 10^-3.
  See Also:
  
  Wikipedia: Milli
- MICRO
  
  public static final MetricPrefix MICRO
  
  Prefix for 10^-6.
  See Also:
  
  Wikipedia: Micro
- NANO
  
  public static final MetricPrefix NANO
  
  Prefix for 10^-9.
  See Also:
  
  Wikipedia: Nano
- PICO
  
  public static final MetricPrefix PICO
  
  Prefix for 10^-12.
- FEMTO
  
  public static final MetricPrefix FEMTO
  
  Prefix for 10^-15.
- ATTO
  
  public static final MetricPrefix ATTO
  
  Prefix for 10^-18.
- ZEPTO
  
  public static final MetricPrefix ZEPTO
  
  Prefix for 10^-21.
- YOCTO
  
  public static final MetricPrefix YOCTO
  
  Prefix for 10^-24.
- RONTO
  
  public static final MetricPrefix RONTO
  
  Prefix for 10^-27.
- QUECTO
  
  public static final MetricPrefix QUECTO
  
  Prefix for 10^-30.
Method Details
- values
  
  public static MetricPrefix[] values()
  
  Returns an array containing the constants of this enum type, in the order they are declared.
  
  Returns:
  
  an array containing the constants of this enum type, in the order they are declared
- valueOf
  
  public static MetricPrefix valueOf(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:
  
  IllegalArgumentException - if this enum type has no constant with the specified name
  
  NullPointerException - if the argument is null
- QUETTA
  
  public static <Q extends Quantity<Q>> Unit<Q> QUETTA(Unit<Q> unit)
  
  Returns the specified unit multiplied by the factor 10³⁰
  Type Parameters:
  
  Q - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e30).
  
  See Also:
  
  QUETTA
- RONNA
  
  public static <Q extends Quantity<Q>> Unit<Q> RONNA(Unit<Q> unit)
  
  Returns the specified unit multiplied by the factor 10²⁷
  Type Parameters:
  
  Q - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e27).
  
  See Also:
  
  RONNA
- YOTTA
  
  public static <Q extends Quantity<Q>> Unit<Q> YOTTA(Unit<Q> unit)
  
  Returns the specified unit multiplied by the factor 10²⁴
  Type Parameters:
  
  Q - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e24).
  
  See Also:
  
  YOTTA
- ZETTA
  
  public static <Q extends Quantity<Q>> Unit<Q> ZETTA(Unit<Q> unit)
  
  Returns the specified unit multiplied by the factor 10²¹
  Type Parameters:
  
  Q - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e21).
  
  See Also:
  
  ZETTA
- EXA
  
  public static <Q extends Quantity<Q>> Unit<Q> EXA(Unit<Q> unit)
  
  Returns the specified unit multiplied by the factor 10¹⁸
  Type Parameters:
  
  Q - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e18).
  
  See Also:
  
  EXA
- PETA
  
  public static <Q extends Quantity<Q>> Unit<Q> PETA(Unit<Q> unit)
  
  Returns the specified unit multiplied by the factor 10¹⁵
  Type Parameters:
  
  Q - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e15).
  
  See Also:
  
  PETA
- TERA
  
  public static <Q extends Quantity<Q>> Unit<Q> TERA(Unit<Q> unit)
  
  Returns the specified unit multiplied by the factor 10¹²
  Type Parameters:
  
  Q - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e12).
  
  See Also:
  
  TERA
- GIGA
  
  public static <Q extends Quantity<Q>> Unit<Q> GIGA(Unit<Q> unit)
  
  Returns the specified unit multiplied by the factor 10⁹
  Type Parameters:
  
  Q - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e9).
  
  See Also:
  
  GIGA
- MEGA
  
  public static <Q extends Quantity<Q>> Unit<Q> MEGA(Unit<Q> unit)
  
  Returns the specified unit multiplied by the factor 10⁶
  Type Parameters:
  
  Q - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e6).
  
  See Also:
  
  MEGA
- KILO
  
  public static <Q extends Quantity<Q>> Unit<Q> KILO(Unit<Q> unit)
  
  Returns the specified unit multiplied by the factor 10³
  Type Parameters:
  
  Q - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e3).
  
  See Also:
  
  KILO
- HECTO
  
  public static <Q extends Quantity<Q>> Unit<Q> HECTO(Unit<Q> unit)
  
  Returns the specified unit multiplied by the factor 10²
  Type Parameters:
  
  Q - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e2).
  
  See Also:
  
  HECTO
- DECA
  
  public static <Q extends Quantity<Q>> Unit<Q> DECA(Unit<Q> unit)
  
  Returns the specified unit multiplied by the factor 10¹
  Type Parameters:
  
  Q - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e1).
  
  See Also:
  
  DECA
- DEKA
  
  public static <Q extends Quantity<Q>> Unit<Q> DEKA(Unit<Q> unit)
  
  US alias for DECA.
  Type Parameters:
  
  Q - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e1).
  
  See Also:
  
  DECA
- 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 - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e-1).
  
  See Also:
  
  DECI
- 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 - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e-2).
  
  See Also:
  
  CENTI
- 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 - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e-3).
  
  See Also:
  
  MILLI
- 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 - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e-6).
  
  See Also:
  
  MICRO
- 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 - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e-9).
  
  See Also:
  
  NANO
- 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 - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e-12).
  
  See Also:
  
  PICO
- 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 - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e-15).
  
  See Also:
  
  FEMTO
- 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 - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e-18).
  
  See Also:
  
  ATTO
- 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 - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e-21). #see ZEPTO
- 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 - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e-24).
  
  See Also:
  
  YOCTO
- RONTO
  
  public static <Q extends Quantity<Q>> Unit<Q> RONTO(Unit<Q> unit)
  
  Returns the specified unit multiplied by the factor 10^-27
  Type Parameters:
  
  Q - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e-27).
  
  See Also:
  
  RONTO
- QUECTO
  
  public static <Q extends Quantity<Q>> Unit<Q> QUECTO(Unit<Q> unit)
  
  Returns the specified unit multiplied by the factor 10^-30
  Type Parameters:
  
  Q - type of the quantity measured by the unit.
  
  Parameters:
  
  unit - any unit.
  
  Returns:
  
  unit.times(1e-30).
  
  See Also:
  
  QUECTO
- getSymbol
  
  public String getSymbol()
  
  Returns the symbol of this prefix.
  
  Specified by:
  
  getSymbol in interface Prefix
  
  Returns:
  
  this prefix symbol, not null.
- getValue
  
  public Integer getValue()
  
  Base part of the associated factor in base^exponent representation. For metric prefix, this is always 10.
  
  Specified by:
  
  getValue in interface Prefix
  
  Returns:
  
  The prefix value.
- 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 String getName()
  
  Returns the name of this prefix.
  
  Specified by:
  
  getName in interface Prefix
  
  Returns:
  
  this prefix name, not null.

Enum MetricPrefix

Nested Class Summary

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

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Details

QUETTA

RONNA

YOTTA

ZETTA

EXA

PETA

TERA

GIGA

MEGA

KILO

HECTO

DECA

DECI

CENTI

MILLI

MICRO

NANO

PICO

FEMTO

ATTO

ZEPTO

YOCTO

RONTO

QUECTO

Method Details

values

valueOf