com.hcl.domino.design.format

Enum DateTimeFlag

java.lang.Object

java.lang.Enum<DateTimeFlag>

com.hcl.domino.design.format.DateTimeFlag

All Implemented Interfaces:

INumberEnum<Integer>, Serializable, Comparable<DateTimeFlag>

public enum DateTimeFlag
extends Enum<DateTimeFlag>
implements INumberEnum<Integer>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALPHAMONTH Require months be INPUT as letters, not digits (e.g.
FOURDIGITYEAR Require 4 digit year on INPUT (not output)
SHOWABBREV Displays the date as an abbriviated date
SHOWDATE Display date element on output
SHOWTIME Display time element on output
STYLE_DMY Date element order: Day-of-week, Day, Month, Year
STYLE_MDY Date element order: Day-of-week, Month, Day, Year
STYLE_MSK This is where we store the style value in DTFlags
STYLE_YMD Date element order: Year, Month, Day, Day-of-week
TWENTYFOURHOUR Display time on output using 24 hour clock format
VALID Validity bit: If 1, use new DTFMT; if 0, use old TFMT

Method Summary

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

VALID

public static final DateTimeFlag VALID

Validity bit: If 1, use new DTFMT; if 0, use old TFMT

FOURDIGITYEAR

public static final DateTimeFlag FOURDIGITYEAR

Require 4 digit year on INPUT (not output)

ALPHAMONTH

public static final DateTimeFlag ALPHAMONTH

Require months be INPUT as letters, not digits (e.g. "jan", not 01)

SHOWTIME

public static final DateTimeFlag SHOWTIME

Display time element on output

SHOWDATE

public static final DateTimeFlag SHOWDATE

Display date element on output

TWENTYFOURHOUR

public static final DateTimeFlag TWENTYFOURHOUR

Display time on output using 24 hour clock format

SHOWABBREV

public static final DateTimeFlag SHOWABBREV

Displays the date as an abbriviated date

STYLE_YMD

public static final DateTimeFlag STYLE_YMD

Date element order: Year, Month, Day, Day-of-week

STYLE_MDY

public static final DateTimeFlag STYLE_MDY

Date element order: Day-of-week, Month, Day, Year

STYLE_DMY

public static final DateTimeFlag STYLE_DMY

Date element order: Day-of-week, Day, Month, Year

STYLE_MSK

public static final DateTimeFlag STYLE_MSK

This is where we store the style value in DTFlags

Method Detail

values

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

Returns:

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

valueOf

public static DateTimeFlag 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<Integer>

Returns:

the C-level value of the enum as a long

getValue

public Integer getValue()

Specified by:

getValue in interface INumberEnum<Integer>

Returns:

the C-level value of the enum