com.hcl.domino.design.format

Enum YearFormat

java.lang.Object

java.lang.Enum<YearFormat>

com.hcl.domino.design.format.YearFormat

All Implemented Interfaces:

INumberEnum<Byte>, Serializable, Comparable<YearFormat>

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
GE Single letter (first letter ) of epoch name and 1 or 2 digit (no leading zeros) year
GEE Single letter (first letter ) of epoch name and 2 digit (with leading zeros, if necessary) year
GGE
GGEE Abbreviated spelling and 2 digit (with leading zeros, if necessary) year
GGGE
GGGEE fully spelled out epoch name and 2 digit (with leading zeros, if necessary) year
YY 2 digit year
YYYY 4 digit year

Method Summary

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

YY

public static final YearFormat YY

2 digit year

YYYY

public static final YearFormat YYYY

4 digit year

GE

public static final YearFormat GE

Single letter (first letter ) of epoch name and 1 or 2 digit (no leading zeros) year

GEE

public static final YearFormat GEE

Single letter (first letter ) of epoch name and 2 digit (with leading zeros, if necessary) year

GGE

public static final YearFormat GGE

GGEE

public static final YearFormat GGEE

Abbreviated spelling and 2 digit (with leading zeros, if necessary) year

GGGE

public static final YearFormat GGGE

GGGEE

public static final YearFormat GGGEE

fully spelled out epoch name and 2 digit (with leading zeros, if necessary) year

Method Detail

values

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

Returns:

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

valueOf

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