Package org.jivesoftware.smack.packet

Enum Presence.Type

java.lang.Object

java.lang.Enum<Presence.Type>

org.jivesoftware.smack.packet.Presence.Type

All Implemented Interfaces:

Serializable, Comparable<Presence.Type>

Enclosing class:

Presence

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

An enum to represent the presence type. Note that presence type is often confused with presence mode. Generally, if a user is signed in to a server, they have a presence type of available, even if the mode is away, dnd, etc. The presence type is only unavailable when the user is signing out of the server.

Enum Constant Summary

Enum Constants

Enum Constant	Description
available	The user is available to receive messages (default).
error	The presence stanza contains an error message.
probe	A presence probe as defined in section 4.3 of RFC 6121.
subscribe	Request subscription to recipient's presence.
subscribed	Grant subscription to sender's presence.
unavailable	The user is unavailable to receive messages.
unsubscribe	Request removal of subscription to sender's presence.
unsubscribed	Grant removal of subscription to sender's presence.

Method Summary

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

available

public static final Presence.Type available

The user is available to receive messages (default).

unavailable

public static final Presence.Type unavailable

The user is unavailable to receive messages.

subscribe

public static final Presence.Type subscribe

Request subscription to recipient's presence.

subscribed

public static final Presence.Type subscribed

Grant subscription to sender's presence.

unsubscribe

public static final Presence.Type unsubscribe

Request removal of subscription to sender's presence.

unsubscribed

public static final Presence.Type unsubscribed

Grant removal of subscription to sender's presence.

error

public static final Presence.Type error

The presence stanza contains an error message.

probe

public static final Presence.Type probe

A presence probe as defined in section 4.3 of RFC 6121.

Method Details

values

public static Presence.Type[] values()

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

Returns:

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

valueOf

public static Presence.Type 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.Type fromString(String string)

Converts a String into the corresponding types. Valid String values that can be converted to types are: "available", "unavailable", "subscribe", "subscribed", "unsubscribe", "unsubscribed" and "error".

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