org.josef.science

Enum SiPrefix

java.lang.Object

java.lang.Enum<SiPrefix>

org.josef.science.SiPrefix

All Implemented Interfaces:

Serializable, Comparable<SiPrefix>

@Status(stage=PRODUCTION,
        unitTests=COMPLETE)
 @Review(by="Kees Schotanus",
        at="2010-08-17",
        reason="After unit tests were written")
public enum SiPrefix
extends Enum<SiPrefix>

SI Prefix.
The SI system officially only supports prefixes that are a power of 1000.

Version:

1.0 $Revision: 5877 $

Author:

Kees Schotanus

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATTO Atto.
EXA Exa.
FEMTO Femto.
GIGA Giga.
KILO Kilo.
MEGA Mega.
MICRO Micro.
MILLI Milli.
NANO Nano.
ONE One.
PETA Peta.
PICO Pico.
TERA Tera.
YOCTO Yocto.
YOTTA Yotta.
ZEPTO Zepto.
ZETTA Zetta.

Method Summary

Modifier and Type	Method and Description
double	getFactor() Gets the factor of this SI prefix.
int	getPower() Gets the power of this SI prefix.
String	getSymbol() Gets the symbol of this SiUnit.
String	toString() Creates a String representation of this SI prefix.
static SiPrefix	valueOf(String name) Returns the enum constant of this type with the specified name.
static SiPrefix[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

YOTTA

public static final SiPrefix YOTTA

Yotta.

ZETTA

public static final SiPrefix ZETTA

Zetta.

EXA

public static final SiPrefix EXA

Exa.

PETA

public static final SiPrefix PETA

Peta.

TERA

public static final SiPrefix TERA

Tera.

GIGA

public static final SiPrefix GIGA

Giga.

MEGA

public static final SiPrefix MEGA

Mega.

KILO

public static final SiPrefix KILO

Kilo.

ONE

public static final SiPrefix ONE

One.

MILLI

public static final SiPrefix MILLI

Milli.

MICRO

public static final SiPrefix MICRO

Micro.

NANO

public static final SiPrefix NANO

Nano.

PICO

public static final SiPrefix PICO

Pico.

FEMTO

public static final SiPrefix FEMTO

Femto.

ATTO

public static final SiPrefix ATTO

Atto.

ZEPTO

public static final SiPrefix ZEPTO

Zepto.

YOCTO

public static final SiPrefix YOCTO

Yocto.

Method Detail

values

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

Returns:

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

valueOf

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

getSymbol

public String getSymbol()

Gets the symbol of this SiUnit.

Returns:

The symbol of this SiUnit.

getPower

public int getPower()

Gets the power of this SI prefix.
For KILO, 3 is returned.

Returns:

The power of this SI prefix.

getFactor

public double getFactor()

Gets the factor of this SI prefix.
For KILO, 1000 is returned.

Returns:

The factor of this SI prefix.

toString

public String toString()

Creates a String representation of this SI prefix.

Overrides:

toString in class Enum<SiPrefix>

Returns:

A String representation of this SI prefix.