com.hcl.domino.design.format

Enum DateShowSpecial

java.lang.Object

java.lang.Enum<DateShowSpecial>

com.hcl.domino.design.format.DateShowSpecial

All Implemented Interfaces:

INumberEnum<Byte>, Serializable, Comparable<DateShowSpecial>

public enum DateShowSpecial
extends Enum<DateShowSpecial>
implements INumberEnum<Byte>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CURYR Display year when not the current year
NONE No special handling
TODAY Use 'Today', 'Yesterday', 'Tomorrow', when possible
TWO_CURRENT_FOUR_OTHER Output 2 digit year for this century; use 4 digit year for other century
Y4 Always display year on OUTPUT as 4 digit year

Method Summary

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

NONE

public static final DateShowSpecial NONE

No special handling

TODAY

public static final DateShowSpecial TODAY

Use 'Today', 'Yesterday', 'Tomorrow', when possible

Y4

public static final DateShowSpecial Y4

Always display year on OUTPUT as 4 digit year

TWO_CURRENT_FOUR_OTHER

public static final DateShowSpecial TWO_CURRENT_FOUR_OTHER

Output 2 digit year for this century; use 4 digit year for other century

CURYR

public static final DateShowSpecial CURYR

Display year when not the current year

Method Detail

values

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

Returns:

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

valueOf

public static DateShowSpecial 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