com.hcl.domino.data

Enum Item.ItemFlag

java.lang.Object

java.lang.Enum<Item.ItemFlag>

com.hcl.domino.data.Item.ItemFlag

All Implemented Interfaces:

INumberEnum<Integer>, Serializable, Comparable<Item.ItemFlag>

Enclosing interface:

Item

public static enum Item.ItemFlag
extends Enum<Item.ItemFlag>
implements INumberEnum<Integer>

Enum for the field flags for an Item

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENCRYPTED
KEEPLINEBREAKS Special flag to keep \n in string item values instead of replacing them with \0 (e.g.
NAMES
PROTECTED
READERS
READWRITERS
SIGNED
SUMMARY

Method Summary

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

SUMMARY

public static final Item.ItemFlag SUMMARY

NAMES

public static final Item.ItemFlag NAMES

READERS

public static final Item.ItemFlag READERS

READWRITERS

public static final Item.ItemFlag READWRITERS

PROTECTED

public static final Item.ItemFlag PROTECTED

ENCRYPTED

public static final Item.ItemFlag ENCRYPTED

SIGNED

public static final Item.ItemFlag SIGNED

KEEPLINEBREAKS

public static final Item.ItemFlag KEEPLINEBREAKS

Special flag to keep \n in string item values instead of replacing them with \0 (e.g. required when writing $$FormScript in design elements)

Method Detail

values

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

Returns:

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

valueOf

public static Item.ItemFlag 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

getValue

public Integer getValue()

Specified by:

getValue in interface INumberEnum<Integer>

Returns:

the C-level value of the enum

getLongValue

public long getLongValue()

Specified by:

getLongValue in interface INumberEnum<Integer>

Returns:

the C-level value of the enum as a long