org.jivesoftware.smackx
Enum ChatState

java.lang.Object
  java.lang.Enum<ChatState>
      org.jivesoftware.smackx.ChatState

All Implemented Interfaces:

Serializable, Comparable<ChatState>

public enum ChatState
extends Enum<ChatState>

Represents the current state of a users interaction with another user. Implemented according to XEP-0085.

Author:

Alexander Wenckus

Enum Constant Summary

active
User is actively participating in the chat session.

composing
User is composing a message.

gone
User has effectively ended their participation in the chat session.

inactive
User has not been actively participating in the chat session.

paused
User had been composing but now has stopped.

Method Summary

static ChatState	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChatState[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

active

public static final ChatState active

User is actively participating in the chat session.

composing

public static final ChatState composing

User is composing a message.

paused

public static final ChatState paused

User had been composing but now has stopped.

inactive

public static final ChatState inactive

User has not been actively participating in the chat session.

gone

public static final ChatState gone

User has effectively ended their participation in the chat session.

Method Detail

values

public static final ChatState[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(ChatState c : ChatState.values())
        System.out.println(c);

Returns:

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

valueOf

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