com.hcl.domino.richtext.structures

Enum TFMT.DateFormat

java.lang.Object

java.lang.Enum<TFMT.DateFormat>

com.hcl.domino.richtext.structures.TFMT.DateFormat

All Implemented Interfaces:

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

Enclosing interface:

TFMT

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CPARTIAL month and day, year if not this year
CPARTIAL4 month and day, year(4digit) if not this year
DPARTIAL year and month
DPARTIAL4 year(4digit) and month
FULL year, month, and day
FULL4 year(4digit), month, and day
PARTIAL month and day

Method Summary

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

FULL

public static final TFMT.DateFormat FULL

year, month, and day

CPARTIAL

public static final TFMT.DateFormat CPARTIAL

month and day, year if not this year

PARTIAL

public static final TFMT.DateFormat PARTIAL

month and day

DPARTIAL

public static final TFMT.DateFormat DPARTIAL

year and month

FULL4

public static final TFMT.DateFormat FULL4

year(4digit), month, and day

CPARTIAL4

public static final TFMT.DateFormat CPARTIAL4

month and day, year(4digit) if not this year

DPARTIAL4

public static final TFMT.DateFormat DPARTIAL4

year(4digit) and month

Method Detail

values

public static TFMT.DateFormat[] 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.DateFormat c : TFMT.DateFormat.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.DateFormat 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