uk.gov.gchq.koryphe.util

Enum TimeUnit

java.lang.Object

java.lang.Enum<TimeUnit>

uk.gov.gchq.koryphe.util.TimeUnit

All Implemented Interfaces:

Serializable, Comparable<TimeUnit>

public enum TimeUnit
extends Enum<TimeUnit>

A TimeUnit is an enum that defines a period of time. There is a method to convert a time to milliseconds using the time unit.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY
HOUR
MICROSECOND
MILLISECOND
MINUTE
SECOND

Method Summary

Modifier and Type	Method and Description
Long	asMilliSeconds(Long time) Converts a unit of time to milliseconds.
static Long	asMilliSeconds(TimeUnit timeUnit, Long time) Converts a unit of time to milliseconds.
Long	fromMilliSeconds(Long time)
static Long	fromMilliSeconds(TimeUnit timeUnit, Long time)
static TimeUnit	valueOf(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

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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

MICROSECOND

public static final TimeUnit MICROSECOND

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(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

asMilliSeconds

public static Long asMilliSeconds(TimeUnit timeUnit,
                                  Long time)

Converts a unit of time to milliseconds. If the time unit or time is null then null is returned.

Parameters:

timeUnit - the time unit

time - the time

Returns:

the time in milliseconds

fromMilliSeconds

public static Long fromMilliSeconds(TimeUnit timeUnit,
                                    Long time)

asMilliSeconds

public Long asMilliSeconds(Long time)

Converts a unit of time to milliseconds. If the time is null then null is returned.

Parameters:

time - the time

Returns:

the time in milliseconds

fromMilliSeconds

public Long fromMilliSeconds(Long time)