Prefix

java.lang.Object
- java.lang.Enum<Prefix>
- - etomica.units.Prefix

```
public enum Prefix
extends java.lang.Enum<Prefix>
```
Base class for all unit prefixes, such as kilo, micro, nano, etc. A prefix class is specified (with a Unit) to form a PrefixedUnit object. All standard prefixes are available as static fields of this class. These go from YOCTO (10^-24) to YOTTA (10^+24).

See Also:

PrefixedUnit

Enum Constant Summary

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

Field Summary

Fields
Modifier and Type	Field	Description
`static boolean`	`ALLOWED`	Constant used when invoking constructor of SimpleUnit class to indicate that the unit permits the use of a prefix.
`static boolean`	`NOT_ALLOWED`	Constant used when invoking constructor of SimpleUnit class to indicate that the unit does not permit the use of a prefix.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Prefix`	`keySelect(java.lang.String aKey)`	Allows specifying a Prefix from its symbol.
`java.lang.String`	`symbol()`	Symbol used to show that prefix is part of the unit.
`java.lang.String`	`toString()`
`double`	`value()`
`static Prefix`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static Prefix[]`	`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
  - YOCTO
```
public static final Prefix YOCTO
```
  - ZEPTO
```
public static final Prefix ZEPTO
```
  - ATTO
```
public static final Prefix ATTO
```
  - FEMTO
```
public static final Prefix FEMTO
```
  - PICO
```
public static final Prefix PICO
```
  - NANO
```
public static final Prefix NANO
```
  - MICRO
```
public static final Prefix MICRO
```
  - MILLI
```
public static final Prefix MILLI
```
  - CENTI
```
public static final Prefix CENTI
```
  - DECI
```
public static final Prefix DECI
```
  - NULL
```
public static final Prefix NULL
```
  - DEKA
```
public static final Prefix DEKA
```
  - HECTO
```
public static final Prefix HECTO
```
  - KILO
```
public static final Prefix KILO
```
  - MEGA
```
public static final Prefix MEGA
```
  - GIGA
```
public static final Prefix GIGA
```
  - TERA
```
public static final Prefix TERA
```
  - PETA
```
public static final Prefix PETA
```
  - EXA
```
public static final Prefix EXA
```
  - ZETTA
```
public static final Prefix ZETTA
```
  - YOTTA
```
public static final Prefix YOTTA
```
- Field Detail
  - ALLOWED
```
public static final boolean ALLOWED
```
    Constant used when invoking constructor of SimpleUnit class to indicate that the unit permits the use of a prefix.
    
    See Also:
    
    Constant Field Values
  - NOT_ALLOWED
```
public static final boolean NOT_ALLOWED
```
    Constant used when invoking constructor of SimpleUnit class to indicate that the unit does not permit the use of a prefix.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - values
```
public static Prefix[] 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 (Prefix c : Prefix.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Prefix 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
  - keySelect
```
public static Prefix keySelect(java.lang.String aKey)
```
    Allows specifying a Prefix from its symbol. For example, "m" gives MILLI, "M" give MEGA, "f" gives FEMTO, etc.
    
    Parameters:
    
    aKey - the String specifying the desired Prefix
    
    Returns:
    
    the Prefix with symbol matching the String, or null if the String does not correspond to any Prefix.
  - value
```
public double value()
```
    Returns:
    
    the value associated with the prefix. For example, KILO.value() returns 1000.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<Prefix>
    
    Returns:
    
    the name of the prefix. For example, KILO.toString() returns "kilo". All letters in returned string are lower case.
  - symbol
```
public java.lang.String symbol()
```
    Symbol used to show that prefix is part of the unit. For example the "k" in kg.
    
    Returns:
    
    the symbol representing the prefix.

Enum Prefix

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

YOCTO

ZEPTO

ATTO

FEMTO

PICO

NANO

MICRO

MILLI

CENTI

DECI

NULL

DEKA

HECTO

KILO

MEGA

GIGA

TERA

PETA

EXA

ZETTA

YOTTA

Field Detail

ALLOWED

NOT_ALLOWED

Method Detail

values

valueOf

keySelect

value

toString

symbol