Smack

org.jivesoftware.smack.packet
Enum Presence.Type

java.lang.Object
  extended by java.lang.Enum<Presence.Type>
      extended by 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>

A enum to represent the presecence type. Not that presence type is often confused with presence mode. Generally, if a user is signed into 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
available
          The user is available to receive messages (default).
error
          The presence packet contains an error message.
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
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 Detail

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 packet contains an error message.

Method Detail

values

public static Presence.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 (Presence.Type c : Presence.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 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

Smack

Copyright © 2003-2007 Jive Software.