org.javasimon.clock

Enum SimonUnit

java.lang.Object

java.lang.Enum<SimonUnit>

org.javasimon.clock.SimonUnit

All Implemented Interfaces:

Serializable, Comparable<SimonUnit>

public enum SimonUnit
extends Enum<SimonUnit>

Units typically used in Java Simon with amount of nanoseconds they contain.

Enum Constant Summary

Enum Constants

Enum Constant and Description
MICROSECOND
MILLISECOND
NANOSECOND
SECOND

Method Summary

Modifier and Type	Method and Description
int	getDivisor() Returns number of nanoseconds in this unit.
String	getSymbol() Returns the symbol of time unit.
static SimonUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static SimonUnit[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NANOSECOND

public static final SimonUnit NANOSECOND

MICROSECOND

public static final SimonUnit MICROSECOND

MILLISECOND

public static final SimonUnit MILLISECOND

SECOND

public static final SimonUnit SECOND

Method Detail

values

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

Returns:

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

valueOf

public static SimonUnit 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()

Returns the symbol of time unit.

Returns:

symbol of time unit

getDivisor

public int getDivisor()

Returns number of nanoseconds in this unit.

Returns:

number of nanoseconds in this unit