Package com.inductiveautomation.ignition.common.util

Enum TimeUnits

java.lang.Object

java.lang.Enum<TimeUnits>

com.inductiveautomation.ignition.common.util.TimeUnits

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAY
HOUR
MIN
MONTH
MS
SEC
WEEK
YEAR

Method Summary

Modifier and Type	Method	Description
java.util.Date	after(java.util.Date date, int amount)
java.util.Date	before(java.util.Date date, int amount)
static double	fromMillis(long millis, TimeUnits destUnits)
int	getCalendarField()
long	getMilliMultiplier()
static long	toMillis(java.lang.Double time, TimeUnits units)
java.lang.String	toString(java.util.Locale locale)
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

MS

public static final TimeUnits MS

SEC

public static final TimeUnits SEC

MIN

public static final TimeUnits MIN

HOUR

public static final TimeUnits HOUR

DAY

public static final TimeUnits DAY

WEEK

public static final TimeUnits WEEK

MONTH

public static final TimeUnits MONTH

YEAR

public static final TimeUnits YEAR

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

getMilliMultiplier

public long getMilliMultiplier()

toMillis

public static long toMillis(java.lang.Double time,
                            TimeUnits units)

fromMillis

public static double fromMillis(long millis,
                                TimeUnits destUnits)

getCalendarField

public int getCalendarField()

before

public java.util.Date before(java.util.Date date,
                             int amount)

after

public java.util.Date after(java.util.Date date,
                            int amount)

toString

public java.lang.String toString(java.util.Locale locale)

Specified by:

toString in interface Localized