Package rocks.xmpp.extensions.amp.model

Enum Rule.Action

java.lang.Object

java.lang.Enum<Rule.Action>

rocks.xmpp.extensions.amp.model.Rule.Action

All Implemented Interfaces:

Serializable, Comparable<Rule.Action>

Enclosing class:

Rule

public static enum Rule.Action
extends Enum<Rule.Action>

The action defines what occurs when a particular rule is triggered. The value of the action attribute determines the behavior if the rule's condition is met.

See Also:

3.4 Defined Actions

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALERT	The "alert" action triggers a reply <message/> stanza to the sending entity.
DROP	The "drop" action silently discards the message from any further delivery attempts and ensures that it is not placed into offline storage.
ERROR	The "error" action triggers a reply <message/> stanza of type "error" to the sending entity.
NOTIFY	The "notify" action triggers a reply <message/> stanza to the sending entity.

Method Summary

Modifier and Type	Method	Description
static Rule.Action	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Rule.Action[]	values()	Returns an array containing the constants of this enum type, in the order they are 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

ALERT

public static final Rule.Action ALERT

The "alert" action triggers a reply <message/> stanza to the sending entity.

See Also:

3.4.1 alert

DROP

public static final Rule.Action DROP

The "drop" action silently discards the message from any further delivery attempts and ensures that it is not placed into offline storage.

See Also:

3.4.2 drop

ERROR

public static final Rule.Action ERROR

The "error" action triggers a reply <message/> stanza of type "error" to the sending entity.

See Also:

3.4.3 error

NOTIFY

public static final Rule.Action NOTIFY

The "notify" action triggers a reply <message/> stanza to the sending entity.

See Also:

3.4.4 notify

Method Detail

values

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

Returns:

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

valueOf

public static Rule.Action 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