org.apache.james.imap.api.message.request

Enum SearchResultOption

java.lang.Object

java.lang.Enum<SearchResultOption>

org.apache.james.imap.api.message.request.SearchResultOption

All Implemented Interfaces:

Serializable, Comparable<SearchResultOption>

public enum SearchResultOption
extends Enum<SearchResultOption>

Represent ESEARCH result options. See RFC4731 and RFC5182

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL Return all matched message uids formatted as sequence-set
COUNT Return the count of matched messages
MAX Return the maximum uid matched
MIN Return the minimum uid matched
SAVE Save the last ESEARCH returned sequence-set's.

Method Summary

Methods

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

ALL

public static final SearchResultOption ALL

Return all matched message uids formatted as sequence-set

MIN

public static final SearchResultOption MIN

Return the minimum uid matched

MAX

public static final SearchResultOption MAX

Return the maximum uid matched

COUNT

public static final SearchResultOption COUNT

Return the count of matched messages

SAVE

public static final SearchResultOption SAVE

Save the last ESEARCH returned sequence-set's. See RFC5182 2.4. Interaction with ESEARCH Extension

Method Detail

values

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

Returns:

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

valueOf

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