com.openexchange.mail.utils
Enum DisplayMode

java.lang.Object
  java.lang.Enum<DisplayMode>
      com.openexchange.mail.utils.DisplayMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DisplayMode>

public enum DisplayMode
extends java.lang.Enum<DisplayMode>

DisplayMode - The display mode

Author:

Thorben Betten

Enum Constant Summary

DISPLAY
Generate a version for being displayed in front-end

MODIFYABLE
Generate a version for a message forward/reply/draft-edit in front-end

RAW
Generate a version as-is.

Method Summary

int	getMode() Gets the mode's integer value
boolean	isIncluded(DisplayMode other) Indicates if this mode is included in given mode
static DisplayMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DisplayMode[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RAW

public static final DisplayMode RAW

Generate a version as-is.

MODIFYABLE

public static final DisplayMode MODIFYABLE

Generate a version for a message forward/reply/draft-edit in front-end

DISPLAY

public static final DisplayMode DISPLAY

Generate a version for being displayed in front-end

Method Detail

values

public static final DisplayMode[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(DisplayMode c : DisplayMode.values())
        System.out.println(c);

Returns:

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

valueOf

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

getMode

public int getMode()

Gets the mode's integer value

Returns:

The mode's integer value

isIncluded

public boolean isIncluded(DisplayMode other)

Indicates if this mode is included in given mode

Parameters:

other - The other mode

Returns:

true if this mode is included in given mode; otherwise false