com.cryptshare.api

Enum EmailFormat

java.lang.Object

java.lang.Enum<EmailFormat>

com.cryptshare.api.EmailFormat

All Implemented Interfaces:

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

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

Represents the format of an email template.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HTML HTML format.
PLAIN Plain text format.

Method Summary

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

HTML

public static final EmailFormat HTML

HTML format.

PLAIN

public static final EmailFormat PLAIN

Plain text format.

Method Detail

values

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

Returns:

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

valueOf

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