org.jivesoftware.smack.packet

Enum Presence.Mode

java.lang.Object

java.lang.Enum<Presence.Mode>

org.jivesoftware.smack.packet.Presence.Mode

All Implemented Interfaces:

Serializable, Comparable<Presence.Mode>

Enclosing class:

Presence

public static enum Presence.Mode
extends Enum<Presence.Mode>

An enum to represent the presence mode.

Enum Constant Summary

Enum Constants

Enum Constant and Description
available Available (the default).
away Away.
chat Free to chat.
dnd Do not disturb.
xa Away for an extended period of time.

Method Summary

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

chat

public static final Presence.Mode chat

Free to chat.

available

public static final Presence.Mode available

Available (the default).

away

public static final Presence.Mode away

Away.

xa

public static final Presence.Mode xa

Away for an extended period of time.

dnd

public static final Presence.Mode dnd

Do not disturb.

Method Detail

values

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

Returns:

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

valueOf

public static Presence.Mode 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

fromString

public static Presence.Mode fromString(String string)

Converts a String into the corresponding types. Valid String values that can be converted to types are: "chat", "available", "away", "xa", and "dnd".

Parameters:

string - the String value to covert.

Returns:

the corresponding Type.

Throws:

IllegalArgumentException - when not able to parse the string parameter

NullPointerException - if the string is null