org.youscope.uielements

Enum TimeUnit

java.lang.Object

java.lang.Enum<TimeUnit>

org.youscope.uielements.TimeUnit

All Implemented Interfaces:

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

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

Enumeration of typical units used to measure time in YouScope, and their conversion to milliseconds.

Author:

Moritz Lang

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY A day = 24 * 60 * 60 * 1000 ms.
HOUR An hour = 60 * 60 * 1000 ms.
MILLI_SECOND A milli second.
MINUTE A minute = 60 * 1000 ms.
SECOND A second = 1000 ms.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getSIUnit() Returns the SI name of the unit.
int	getUnitToMs() Returns the amount of milli seconds one "piece" of unit has.
boolean	isIntegerInUnit(long timeInMs) Returns true if the given time in ms is an integer value in the given unit.
long	toMs(double timeInUnit) Returns the time in ms a given quantity of time in this unit corresponds to.
java.lang.String	toString()
double	toUnit(long timeInMs) Returns the amount of time in the given 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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MILLI_SECOND

public static final TimeUnit MILLI_SECOND

A milli second.

SECOND

public static final TimeUnit SECOND

A second = 1000 ms.

MINUTE

public static final TimeUnit MINUTE

A minute = 60 * 1000 ms.

HOUR

public static final TimeUnit HOUR

An hour = 60 * 60 * 1000 ms.

DAY

public static final TimeUnit DAY

A day = 24 * 60 * 60 * 1000 ms.

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<TimeUnit>

getSIUnit

public java.lang.String getSIUnit()

Returns the SI name of the unit.

Returns:

SI name of the unit.

getUnitToMs

public int getUnitToMs()

Returns the amount of milli seconds one "piece" of unit has.

Returns:

Amount of millisecond of one unit.

toUnit

public double toUnit(long timeInMs)

Returns the amount of time in the given unit.

Parameters:

timeInMs - The time in ms for which the time in the given unit should be calculated.

Returns:

Time in the given unit.

toMs

public long toMs(double timeInUnit)

Returns the time in ms a given quantity of time in this unit corresponds to.

Parameters:

timeInUnit - Time in the given unit.

Returns:

Time in ms.

isIntegerInUnit

public boolean isIntegerInUnit(long timeInMs)

Returns true if the given time in ms is an integer value in the given unit.

Parameters:

timeInMs - Time in ms.

Returns:

True, if the given time is an integer value in the given unit.