net.user1.union.core
Enum UpdateLevel

java.lang.Object
  extended by java.lang.Enum<UpdateLevel>
      extended by net.user1.union.core.UpdateLevel
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<UpdateLevel>

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

UpdateLevel contains a breakdown of information that can be retrieved by the server.


Enum Constant Summary
ALL_ROOM_ATTRIBUTES
           
OBSERVER_COUNT
           
OBSERVER_LIST
           
OBSERVER_LOGIN_LOGOFF
           
OBSERVER_SHARED_GLOBAL_ATTRIBUTES
           
OBSERVER_SHARED_ROOM_ATTRIBUTES
           
OCCUPANT_COUNT
           
OCCUPANT_LIST
           
OCCUPANT_LOGIN_LOGOFF
           
OCCUPANT_SHARED_GLOBAL_ATTRIBUTES
           
OCCUPANT_SHARED_ROOM_ATTRIBUTES
           
ROOM_MESSAGES
           
ROOM_SHARED_ATTRIBUTES
           
 
Field Summary
static int ADMIN_MAX_UPDATE_LEVEL
          The maximum update levels for an admin.
static int ALL_ATTRIBUTE_UPDATES
          And (&) of all attribute update bits (client and room).
 int bit
          The bit that indicates the UpdateLevel is set.
static int NON_ADMIN_MAX_UPDATE_LEVEL
          The maximum update levels for a non-admin.
 
Method Summary
static boolean isAnyAttributeUpdate(int levels)
           
static UpdateLevel valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static UpdateLevel[] 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

ROOM_MESSAGES

public static final UpdateLevel ROOM_MESSAGES

ROOM_SHARED_ATTRIBUTES

public static final UpdateLevel ROOM_SHARED_ATTRIBUTES

OCCUPANT_COUNT

public static final UpdateLevel OCCUPANT_COUNT

OBSERVER_COUNT

public static final UpdateLevel OBSERVER_COUNT

OCCUPANT_LIST

public static final UpdateLevel OCCUPANT_LIST

OBSERVER_LIST

public static final UpdateLevel OBSERVER_LIST

OCCUPANT_SHARED_ROOM_ATTRIBUTES

public static final UpdateLevel OCCUPANT_SHARED_ROOM_ATTRIBUTES

OBSERVER_SHARED_ROOM_ATTRIBUTES

public static final UpdateLevel OBSERVER_SHARED_ROOM_ATTRIBUTES

OCCUPANT_SHARED_GLOBAL_ATTRIBUTES

public static final UpdateLevel OCCUPANT_SHARED_GLOBAL_ATTRIBUTES

OBSERVER_SHARED_GLOBAL_ATTRIBUTES

public static final UpdateLevel OBSERVER_SHARED_GLOBAL_ATTRIBUTES

OCCUPANT_LOGIN_LOGOFF

public static final UpdateLevel OCCUPANT_LOGIN_LOGOFF

OBSERVER_LOGIN_LOGOFF

public static final UpdateLevel OBSERVER_LOGIN_LOGOFF

ALL_ROOM_ATTRIBUTES

public static final UpdateLevel ALL_ROOM_ATTRIBUTES
Field Detail

bit

public int bit
The bit that indicates the UpdateLevel is set.


NON_ADMIN_MAX_UPDATE_LEVEL

public static int NON_ADMIN_MAX_UPDATE_LEVEL
The maximum update levels for a non-admin. Equivalent to setting all bits for which isAdminOnly is false.


ADMIN_MAX_UPDATE_LEVEL

public static int ADMIN_MAX_UPDATE_LEVEL
The maximum update levels for an admin. Equivalent to setting all bits.


ALL_ATTRIBUTE_UPDATES

public static int ALL_ATTRIBUTE_UPDATES
And (&) of all attribute update bits (client and room). Used to determine if the given mask contains any attribute updates.

Method Detail

values

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

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

valueOf

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

isAnyAttributeUpdate

public static boolean isAnyAttributeUpdate(int levels)


Copyright USER1 Subsystems Corporation - Tue Jan 28 2014, 05:05 PM -0500