com.hcl.domino.richtext.structures

Enum NFMT.Format

java.lang.Object

java.lang.Enum<NFMT.Format>

com.hcl.domino.richtext.structures.NFMT.Format

All Implemented Interfaces:

INumberEnum<Byte>, Serializable, Comparable<NFMT.Format>

Enclosing interface:

NFMT

public static enum NFMT.Format
extends Enum<NFMT.Format>
implements INumberEnum<Byte>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CURRENCY The appropriate currency symbol will be displayed with the number.
FIXED The number displayed will contain to the right of the decimal point the number of digits specified in the NFMT.Digits structure member.
GENERAL Only the significant digits in a number will be displayed; leading zeroes and trailing zeroes will be stripped.
SCIENTIFIC The number will be displayed in scientific notation.

Method Summary

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

GENERAL

public static final NFMT.Format GENERAL

Only the significant digits in a number will be displayed; leading zeroes and trailing zeroes will be stripped.

FIXED

public static final NFMT.Format FIXED

The number displayed will contain to the right of the decimal point the number of digits specified in the NFMT.Digits structure member. The number will be either truncated or padded with zeroes, as appropriate.

SCIENTIFIC

public static final NFMT.Format SCIENTIFIC

The number will be displayed in scientific notation.

CURRENCY

public static final NFMT.Format CURRENCY

The appropriate currency symbol will be displayed with the number.

Method Detail

values

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

Returns:

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

valueOf

public static NFMT.Format 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