org.cyclos.model.utils

Enum SendMedium

java.lang.Object

java.lang.Enum<SendMedium>

org.cyclos.model.utils.SendMedium

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SendMedium>, HasMessageKey

public enum SendMedium
extends java.lang.Enum<SendMedium>
implements HasMessageKey

Defines the possibles mediums for sending a notification to an user

Author:

ameyer

Enum Constant Summary

Enum Constants

Enum Constant and Description
EMAIL The notification will be sent by email
SMS The notification will be sent by sms

Method Summary

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

EMAIL

public static final SendMedium EMAIL

The notification will be sent by email

SMS

public static final SendMedium SMS

The notification will be sent by sms

Method Detail

values

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

Returns:

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

valueOf

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

getMessageKey

public MessageKey getMessageKey()

Specified by:

getMessageKey in interface HasMessageKey