org.jivesoftware.smack.packet

Enum Message.Type

java.lang.Object

java.lang.Enum<Message.Type>

org.jivesoftware.smack.packet.Message.Type

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Message.Type>

Enclosing class:

Message

public static enum Message.Type
extends java.lang.Enum<Message.Type>

Represents the type of a message.

Enum Constant Summary

Enum Constants

Enum Constant and Description
chat Typically short text message used in line-by-line chat interfaces.
error indicates a messaging error.
groupchat Chat message sent to a groupchat server for group chats.
headline Text message to be displayed in scrolling marquee displays.
normal (Default) a normal text message used in email like interface.

Method Summary

Modifier and Type	Method and Description
static Message.Type	fromString(java.lang.String string) Converts a String into the corresponding types.
static Message.Type	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Message.Type[]	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

normal

public static final Message.Type normal

(Default) a normal text message used in email like interface.

chat

public static final Message.Type chat

Typically short text message used in line-by-line chat interfaces.

groupchat

public static final Message.Type groupchat

Chat message sent to a groupchat server for group chats.

headline

public static final Message.Type headline

Text message to be displayed in scrolling marquee displays.

error

public static final Message.Type error

indicates a messaging error.

Method Detail

values

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

Returns:

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

valueOf

public static Message.Type 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

fromString

public static Message.Type fromString(java.lang.String string)

Converts a String into the corresponding types. Valid String values that can be converted to types are: "normal", "chat", "groupchat", "headline" and "error".

Parameters:

string - the String value to covert.

Returns:

the corresponding Type.

Throws:

java.lang.IllegalArgumentException - when not able to parse the string parameter

java.lang.NullPointerException - if the string is null