com.inductiveautomation.ignition.common.util

Enum Timeline.TimelineStyle

java.lang.Object

java.lang.Enum<Timeline.TimelineStyle>

com.inductiveautomation.ignition.common.util.Timeline.TimelineStyle

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Timeline.TimelineStyle>

Enclosing class:

Timeline

public static enum Timeline.TimelineStyle
extends java.lang.Enum<Timeline.TimelineStyle>

Enum Constant Summary

Enum Constants

Enum Constant and Description
Calandar
TimeOfDay

Method Summary

Modifier and Type	Method and Description
java.util.Date	toDateForStyle(long value) Returns the opposite of toLongForStyle
long	toLongForStyle(java.util.Date value) Takes the date, and returns the appropriate value for it for the given style.
long	toLongForStyle(long dateMillis) Takes the date as time, and returns the appropriate value for it for the given style.
static Timeline.TimelineStyle	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Timeline.TimelineStyle[]	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

Calandar

public static final Timeline.TimelineStyle Calandar

TimeOfDay

public static final Timeline.TimelineStyle TimeOfDay

Method Detail

values

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

Returns:

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

valueOf

public static Timeline.TimelineStyle 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

toLongForStyle

public long toLongForStyle(java.util.Date value)

Takes the date, and returns the appropriate value for it for the given style.

toLongForStyle

public long toLongForStyle(long dateMillis)

Takes the date as time, and returns the appropriate value for it for the given style.

toDateForStyle

public java.util.Date toDateForStyle(long value)

Returns the opposite of toLongForStyle