org.apache.james.mailbox
Enum MailboxMetaData.Children

java.lang.Object
  java.lang.Enum<MailboxMetaData.Children>
      org.apache.james.mailbox.MailboxMetaData.Children

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MailboxMetaData.Children>

Enclosing interface:

MailboxMetaData

public static enum MailboxMetaData.Children
extends java.lang.Enum<MailboxMetaData.Children>

Indicates whether this mailbox allows children and - if so - whether it has any.

Enum Constant Summary

CHILDREN_ALLOWED_BUT_UNKNOWN
Children allowed by this mailbox but it is unknown whether this mailbox has children.

HAS_CHILDREN
Indicates that this mailbox has children.

HAS_NO_CHILDREN
Indicates that this mailbox allows interiors but currently has no children.

NO_INFERIORS
No children allowed.

Method Summary

static MailboxMetaData.Children	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MailboxMetaData.Children[]	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

NO_INFERIORS

public static final MailboxMetaData.Children NO_INFERIORS

No children allowed.

CHILDREN_ALLOWED_BUT_UNKNOWN

public static final MailboxMetaData.Children CHILDREN_ALLOWED_BUT_UNKNOWN

Children allowed by this mailbox but it is unknown whether this mailbox has children.

HAS_CHILDREN

public static final MailboxMetaData.Children HAS_CHILDREN

Indicates that this mailbox has children.

HAS_NO_CHILDREN

public static final MailboxMetaData.Children HAS_NO_CHILDREN

Indicates that this mailbox allows interiors but currently has no children.

Method Detail

values

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

Returns:

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

valueOf

public static MailboxMetaData.Children valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null