org.xwiki.notifications

Enum NotificationFormat

java.lang.Object

java.lang.Enum<NotificationFormat>

org.xwiki.notifications.NotificationFormat

All Implemented Interfaces:

Serializable, Comparable<NotificationFormat>

public enum NotificationFormat
extends Enum<NotificationFormat>

The different formats for notifications.

Since:

9.5RC1

Version:

$Id: 3d9d68c75611991998bfcb5113c4b15c47a71875 $

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALERT Notification displayed in the UI (as an "alert").
EMAIL Notification sent by email.

Method Summary

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

ALERT

public static final NotificationFormat ALERT

Notification displayed in the UI (as an "alert").

EMAIL

public static final NotificationFormat EMAIL

Notification sent by email.

Method Detail

values

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

Returns:

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

valueOf

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