com.hcl.domino.richtext.structures

Enum TFMT.TimeStructure

java.lang.Object

java.lang.Enum<TFMT.TimeStructure>

com.hcl.domino.richtext.structures.TFMT.TimeStructure

All Implemented Interfaces:

INumberEnum<Byte>, Serializable, Comparable<TFMT.TimeStructure>

Enclosing interface:

TFMT

public static enum TFMT.TimeStructure
extends Enum<TFMT.TimeStructure>
implements INumberEnum<Byte>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CDATETIME DATE TIME or TIME Today or TIME Yesterday
DATE DATE
DATETIME DATE TIME
TIME TIME

Method Summary

Modifier and Type	Method and Description
long	getLongValue()
Byte	getValue()
static TFMT.TimeStructure	valueOf(String name) Returns the enum constant of this type with the specified name.
static TFMT.TimeStructure[]	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

DATE

public static final TFMT.TimeStructure DATE

DATE

TIME

public static final TFMT.TimeStructure TIME

TIME

DATETIME

public static final TFMT.TimeStructure DATETIME

DATE TIME

CDATETIME

public static final TFMT.TimeStructure CDATETIME

DATE TIME or TIME Today or TIME Yesterday

Method Detail

values

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

Returns:

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

valueOf

public static TFMT.TimeStructure 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

getLongValue

public long getLongValue()

Specified by:

getLongValue in interface INumberEnum<Byte>

Returns:

the C-level value of the enum as a long

getValue

public Byte getValue()

Specified by:

getValue in interface INumberEnum<Byte>

Returns:

the C-level value of the enum