Package com.ohacd.matchbox.api

Enum Class ChatResult

java.lang.Object

java.lang.Enum<ChatResult>

com.ohacd.matchbox.api.ChatResult

All Implemented Interfaces:

Serializable, Comparable<ChatResult>, Constable

public enum ChatResult
extends Enum<ChatResult>

Result of processing a chat message through the pipeline. Determines how the message should be handled after custom processing.

Since:

0.9.5

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALLOW	Allow the message to proceed through the normal routing.
CANCEL	Cancel the message entirely - prevents any further processing.
DENY	Deny the message - it will not be sent to any recipients.

Method Summary

Modifier and Type	Method	Description
static ChatResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ChatResult[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALLOW

public static final ChatResult ALLOW

Allow the message to proceed through the normal routing. The message may have been modified by the processor.

DENY

public static final ChatResult DENY

Deny the message - it will not be sent to any recipients. Useful for filtering spam, muted players, etc.

CANCEL

public static final ChatResult CANCEL

Cancel the message entirely - prevents any further processing. Similar to DENY but stops the pipeline immediately.

Method Details

values

public static ChatResult[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ChatResult valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null