prajna.data

Enum TimeUnit

java.lang.Object

java.lang.Enum<TimeUnit>

prajna.data.TimeUnit

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TimeUnit>, Unit

public enum TimeUnit
extends java.lang.Enum<TimeUnit>
implements Unit

Implementation of a Units class for temporal measure, e.g., for time values. This class is primarily designed for use of time with other units of measurement. The base time unit is the second. Conversions to units of Days or larger are estimated, and do not account for leap-seconds.

Author:

Edward Swing

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY
HOUR
MILLISECOND
MINUTE
MONTH
SECOND
WEEK
YEAR

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAbbreviation() Get the abbreviation for the unit
double	getConvertFactor() Get the conversion factor for this unit.
static TimeUnit	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TimeUnit[]	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

YEAR

public static final TimeUnit YEAR

MONTH

public static final TimeUnit MONTH

WEEK

public static final TimeUnit WEEK

DAY

public static final TimeUnit DAY

HOUR

public static final TimeUnit HOUR

MINUTE

public static final TimeUnit MINUTE

SECOND

public static final TimeUnit SECOND

MILLISECOND

public static final TimeUnit MILLISECOND

Method Detail

values

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

Returns:

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

valueOf

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

getAbbreviation

public java.lang.String getAbbreviation()

Get the abbreviation for the unit

Specified by:

getAbbreviation in interface Unit

Returns:

the abbreviation

getConvertFactor

public double getConvertFactor()

Get the conversion factor for this unit.

Specified by:

getConvertFactor in interface Unit

Returns:

the conversion factor