Package org.jivesoftware.openfire.muc

Enum Affiliation

  • All Implemented Interfaces:
    Serializable, Comparable<Affiliation>
    public enum Affiliation
extends Enum<Affiliation>
    A long-lived association or connection with a room. Affiliation is distinct from role. An affiliation lasts across a user's visits to a room.

    • Enum Constant Detail

      • owner

        public static final Affiliation owner
        Owner of the room.

      • admin

        public static final Affiliation admin
        Administrator of the room.

      • 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.

      • outcast

        public static final Affiliation outcast
        A user who has been banned from a room.

      • none

        public static final Affiliation none
        A user who doesn't have an affiliation. This kind of users can register with members-only rooms and may enter an open room.

    • 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​(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()
        Returns the value for the affiliation.
        Returns:
        the value.

      • valueOf

        public static Affiliation valueOf​(int value)
        Returns the affiliation associated with the specified value.
        Parameters:
        value - the value.
        Returns:
        the associated affiliation.