Package org.jivesoftware.openfire.roster

Enum RosterItem.SubType

java.lang.Object

java.lang.Enum<RosterItem.SubType>

org.jivesoftware.openfire.roster.RosterItem.SubType

All Implemented Interfaces:

Serializable, Comparable<RosterItem.SubType>

Enclosing class:

RosterItem

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

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTH	The roster item and owner have a mutual subscription.
FROM	The roster item has a subscription to the roster owner's presence.
NONE	No subscription is established.
REMOVE	Indicates the roster item should be removed.
TO	The roster owner has a subscription to the roster item's presence.

Method Summary

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

REMOVE

public static final RosterItem.SubType REMOVE

Indicates the roster item should be removed.

NONE

public static final RosterItem.SubType NONE

No subscription is established.

TO

public static final RosterItem.SubType TO

The roster owner has a subscription to the roster item's presence.

FROM

public static final RosterItem.SubType FROM

The roster item has a subscription to the roster owner's presence.

BOTH

public static final RosterItem.SubType BOTH

The roster item and owner have a mutual subscription.

Method Detail

values

public static RosterItem.SubType[] 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.SubType c : RosterItem.SubType.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.SubType 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()

getName

public String getName()

getTypeFromInt

public static RosterItem.SubType getTypeFromInt(int value)