org.xmpp.packet
Enum Presence.Type

java.lang.Object
  extended by java.lang.Enum<Presence.Type>
      extended by org.xmpp.packet.Presence.Type
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Presence.Type>
Enclosing class:
Presence

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

Represents the type of a presence packet. Note: the presence is assumed to be "available" when the type attribute of the packet is null. The valid types are:


Enum Constant Summary
error
          An error has occurred regarding processing or delivery of a previously-sent presence stanza.
probe
          A request for an entity's current presence; SHOULD be generated only by a server on behalf of a user.
subscribe
          The sender wishes to subscribe to the recipient's presence.
subscribed
          The sender has allowed the recipient to receive their presence.
unavailable
          Typically short text message used in line-by-line chat interfaces.
unsubscribe
          The sender is unsubscribing from another entity's presence.
unsubscribed
          The subscription request has been denied or a previously-granted subscription has been cancelled.
 
Method Summary
static Presence.Type valueOf(java.lang.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'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

unavailable

public static final Presence.Type unavailable
Typically short text message used in line-by-line chat interfaces.


subscribe

public static final Presence.Type subscribe
The sender wishes to subscribe to the recipient's presence.


subscribed

public static final Presence.Type subscribed
The sender has allowed the recipient to receive their presence.


unsubscribe

public static final Presence.Type unsubscribe
The sender is unsubscribing from another entity's presence.


unsubscribed

public static final Presence.Type unsubscribed
The subscription request has been denied or a previously-granted subscription has been cancelled.


probe

public static final Presence.Type probe
A request for an entity's current presence; SHOULD be generated only by a server on behalf of a user.


error

public static final Presence.Type error
An error has occurred regarding processing or delivery of a previously-sent presence stanza.

Method Detail

values

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

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

valueOf

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


Copyright © 2009-2010 Ignite Realtime. All Rights Reserved.