ikr.simlib.events.time

Enum TimeUnits

java.lang.Object

java.lang.Enum<TimeUnits>

ikr.simlib.events.time.TimeUnits

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TimeUnits>

public enum TimeUnits
extends java.lang.Enum<TimeUnits>

Predefined units to use in combination with TimeBase. The enum members can be used to easily set the smallest time unit that can be expressed by the classes PointInTime and Duration.

Author:

sscholz

Enum Constant Summary

Enum Constants

Enum Constant and Description
d
h
m
ms
ns
ps
s
us

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getName()
java.lang.String	getShortName()
double	getTimeBase()
static TimeUnits	getTimeUnitByShortName(java.lang.String timeUnit)
static TimeUnits	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TimeUnits[]	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

ps

public static final TimeUnits ps

ns

public static final TimeUnits ns

us

public static final TimeUnits us

ms

public static final TimeUnits ms

s

public static final TimeUnits s

m

public static final TimeUnits m

h

public static final TimeUnits h

d

public static final TimeUnits d

Method Detail

values

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

Returns:

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

valueOf

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

getTimeBase

public double getTimeBase()

getName

public java.lang.String getName()

getShortName

public java.lang.String getShortName()

getTimeUnitByShortName

public static TimeUnits getTimeUnitByShortName(java.lang.String timeUnit)