Smack

org.jivesoftware.smack
Enum Roster.SubscriptionMode

java.lang.Object
  extended by java.lang.Enum<Roster.SubscriptionMode>
      extended by org.jivesoftware.smack.Roster.SubscriptionMode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Roster.SubscriptionMode>
Enclosing class:
Roster

public static enum Roster.SubscriptionMode
extends java.lang.Enum<Roster.SubscriptionMode>

An enumeration for the subscription mode options.


Enum Constant Summary
accept_all
          Automatically accept all subscription and unsubscription requests.
manual
          Subscription requests are ignored, which means they must be manually processed by registering a listener for presence packets and then looking for any presence requests that have the type Presence.Type.SUBSCRIBE or Presence.Type.UNSUBSCRIBE.
reject_all
          Automatically reject all subscription requests.
 
Method Summary
static Roster.SubscriptionMode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static Roster.SubscriptionMode[] 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

accept_all

public static final Roster.SubscriptionMode accept_all
Automatically accept all subscription and unsubscription requests. This is the default mode and is suitable for simple client. More complex client will likely wish to handle subscription requests manually.


reject_all

public static final Roster.SubscriptionMode reject_all
Automatically reject all subscription requests.


manual

public static final Roster.SubscriptionMode manual
Subscription requests are ignored, which means they must be manually processed by registering a listener for presence packets and then looking for any presence requests that have the type Presence.Type.SUBSCRIBE or Presence.Type.UNSUBSCRIBE.

Method Detail

values

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

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

valueOf

public static Roster.SubscriptionMode 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

Smack

Copyright © 2003-2007 Jive Software.