org.frogx.service.api
Enum MUGOccupant.Affiliation

java.lang.Object
  extended by java.lang.Enum<MUGOccupant.Affiliation>
      extended by org.frogx.service.api.MUGOccupant.Affiliation
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<MUGOccupant.Affiliation>
Enclosing interface:
MUGOccupant

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

The Affiliation represents the authorization of an MUGOccupant.

Author:
Günther Nieß

Enum Constant Summary
member
          A user who is on the "whitelist" for a members-only room.
none
          A user who doesn't have an affiliation.
owner
          Owner of the room.
 
Method Summary
 int getValue()
          Returns the value for the affiliation.
static MUGOccupant.Affiliation valueOf(int value)
          Returns the affiliation associated with the specified value.
static MUGOccupant.Affiliation valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static MUGOccupant.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 MUGOccupant.Affiliation owner
Owner of the room.


member

public static final MUGOccupant.Affiliation member
A user who is on the "whitelist" for a members-only room.


none

public static final MUGOccupant.Affiliation none
A user who doesn't have an affiliation.

Method Detail

values

public static MUGOccupant.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 (MUGOccupant.Affiliation c : MUGOccupant.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 MUGOccupant.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

getValue

public int getValue()
Returns the value for the affiliation.

Returns:
the value.

valueOf

public static MUGOccupant.Affiliation valueOf(int value)
Returns the affiliation associated with the specified value.

Parameters:
value - the integer value.
Returns:
the associated affiliation.


Copyright © 2009. All Rights Reserved.