org.jivesoftware.smackx.chat_markers

Enum ChatMarkersState

java.lang.Object

java.lang.Enum<ChatMarkersState>

org.jivesoftware.smackx.chat_markers.ChatMarkersState

All Implemented Interfaces:

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

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

Chat Markers elements (XEP-0333).

See Also:

XEP-0333: Chat Markers

Enum Constant Summary

Enum Constants

Enum Constant and Description
acknowledged The message has been acknowledged by some user interaction e.g.
displayed The message has been displayed to a user in a active chat and not in a system notification.
markable Indicates that a message can be marked with a Chat Marker and is therefore a "markable message".
received The message has been received by a client.

Method Summary

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

markable

public static final ChatMarkersState markable

Indicates that a message can be marked with a Chat Marker and is therefore a "markable message".

received

public static final ChatMarkersState received

The message has been received by a client.

displayed

public static final ChatMarkersState displayed

The message has been displayed to a user in a active chat and not in a system notification.

acknowledged

public static final ChatMarkersState acknowledged

The message has been acknowledged by some user interaction e.g. pressing an acknowledgement button.

Method Detail

values

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

Returns:

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

valueOf

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