com.hcl.domino.data

Enum CollectionEntry.SpecialValue

java.lang.Object

java.lang.Enum<CollectionEntry.SpecialValue>

com.hcl.domino.data.CollectionEntry.SpecialValue

All Implemented Interfaces:

Serializable, Comparable<CollectionEntry.SpecialValue>

Enclosing interface:

CollectionEntry

public static enum CollectionEntry.SpecialValue
extends Enum<CollectionEntry.SpecialValue>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANYUNREAD Special value to check if the collection entry or any descendant is unread
CHILDCOUNT Special value to read child count of collection entry
DESCENDANTCOUNT Special value to read descendant count of collection entry
INDEXPOSITION Special value to read collection index position of collection entry
SEQUENCENUMBER Special value to read sequence number of collection entry
SEQUENCETIME Special value to read sequence number of collection entry
SIBLINGCOUNT Special value to read sibling count of collection entry
UNREAD Special value to check if the collection entry is unread

Method Summary

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

INDEXPOSITION

public static final CollectionEntry.SpecialValue INDEXPOSITION

Special value to read collection index position of collection entry

CHILDCOUNT

public static final CollectionEntry.SpecialValue CHILDCOUNT

Special value to read child count of collection entry

SIBLINGCOUNT

public static final CollectionEntry.SpecialValue SIBLINGCOUNT

Special value to read sibling count of collection entry

DESCENDANTCOUNT

public static final CollectionEntry.SpecialValue DESCENDANTCOUNT

Special value to read descendant count of collection entry

SEQUENCENUMBER

public static final CollectionEntry.SpecialValue SEQUENCENUMBER

Special value to read sequence number of collection entry

SEQUENCETIME

public static final CollectionEntry.SpecialValue SEQUENCETIME

Special value to read sequence number of collection entry

UNREAD

public static final CollectionEntry.SpecialValue UNREAD

Special value to check if the collection entry is unread

ANYUNREAD

public static final CollectionEntry.SpecialValue ANYUNREAD

Special value to check if the collection entry or any descendant is unread

Method Detail

values

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

Returns:

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

valueOf

public static CollectionEntry.SpecialValue 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 String getValue()