tigase.muc
Enum Affiliation

java.lang.Object
  java.lang.Enum<Affiliation>
      tigase.muc.Affiliation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Affiliation>

public enum Affiliation
extends java.lang.Enum<Affiliation>

A long-lived association or connection with a room; the possible affiliations are "owner", "admin", "member", and "outcast" (naturally it is also possible to have no affiliation); affiliation is distinct from role. An affiliation lasts across a user's visits to a room.

Created: 2007-01-26 16:30:15

Version:

$Rev: 81 $

Author:

bmalkow

Enum Constant Summary

ADMIN
A user empowered by the room owner to perform administrative functions such as banning users; however, is not allowed to change defining room features.

MEMBER
A user who is on the "whitelist" for a members-only room or who is registered with an open room.

NONE
Absence of role.

OUTCAST
A user who has been banned from a room.

OWNER
The Jabber user who created the room or a Jabber user who has been designated by the room creator or owner as someone with owner privileges (if allowed); is allowed to change defining room features as well as perform all administrative functions.

Method Summary

int	getWeight()
static Affiliation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Affiliation[]	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

OWNER

public static final Affiliation OWNER

The Jabber user who created the room or a Jabber user who has been designated by the room creator or owner as someone with owner privileges (if allowed); is allowed to change defining room features as well as perform all administrative functions.

ADMIN

public static final Affiliation ADMIN

A user empowered by the room owner to perform administrative functions such as banning users; however, is not allowed to change defining room features.

MEMBER

public static final Affiliation MEMBER

A user who is on the "whitelist" for a members-only room or who is registered with an open room.

NONE

public static final Affiliation NONE

Absence of role. Internal usage only.

OUTCAST

public static final Affiliation OUTCAST

A user who has been banned from a room. An outcast has an affiliation of "outcast".

Method Detail

values

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

Returns:

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

valueOf

public static Affiliation 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

getWeight

public int getWeight()

Returns:

Returns the weight.