Package org.jivesoftware.openfire.roster

Enum RosterItem.AskType

java.lang.Object

java.lang.Enum<RosterItem.AskType>

org.jivesoftware.openfire.roster.RosterItem.AskType

All Implemented Interfaces:

Serializable, Comparable<RosterItem.AskType>

Enclosing class:

RosterItem

public static enum RosterItem.AskType
extends Enum<RosterItem.AskType>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NONE	The roster item has no pending subscription requests.
SUBSCRIBE	The roster item has been asked for permission to subscribe to their presence but no response has been received.
UNSUBSCRIBE	The roster owner has asked to the roster item to unsubscribe from it's presence but has not received confirmation.

Method Summary

Modifier and Type	Method	Description
static RosterItem.AskType	getTypeFromInt(int value)
int	getValue()
static RosterItem.AskType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RosterItem.AskType[]	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

NONE

public static final RosterItem.AskType NONE

The roster item has no pending subscription requests.

SUBSCRIBE

public static final RosterItem.AskType SUBSCRIBE

The roster item has been asked for permission to subscribe to their presence but no response has been received.

UNSUBSCRIBE

public static final RosterItem.AskType UNSUBSCRIBE

The roster owner has asked to the roster item to unsubscribe from it's presence but has not received confirmation.

Method Detail

values

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

Returns:

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

valueOf

public static RosterItem.AskType 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

getValue

public int getValue()

getTypeFromInt

public static RosterItem.AskType getTypeFromInt(int value)