net.sf.josceleton.core.api.entity
Enum UserState

java.lang.Object
  extended by java.lang.Enum<UserState>
      extended by net.sf.josceleton.core.api.entity.UserState
All Implemented Interfaces:
Serializable, Comparable<UserState>

public enum UserState
extends Enum<UserState>

Represents OSC addresses used for user related messages sent by OSCeleton.

Since:
0.1

Enum Constant Summary
DEAD
          Represents the message sent for address /lost_user.
PROCESSING
          Represents the message sent for address /new_skel.
WAITING
          Represents the message sent for address /new_user.
 
Method Summary
abstract
<T> T
callback(UserStateFunction<T> callee)
           
static UserState valueOf(String name)
          Returns the enum constant of this type with the specified name.
static UserState[] 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

WAITING

public static final UserState WAITING
Represents the message sent for address /new_user. Indicates OSCeleton is currently waiting to identify skeleton by detecting a PSI-position.

Since:
0.1

PROCESSING

public static final UserState PROCESSING
Represents the message sent for address /new_skel. Indicating that skeleton data will now be processed.

Since:
0.1

DEAD

public static final UserState DEAD
Represents the message sent for address /lost_user. Indicates OSCeleton lost track of a user.

Since:
0.1
Method Detail

values

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

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

valueOf

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

callback

public abstract <T> T callback(UserStateFunction<T> callee)
Since:
0.3


Copyright © 2011 Josceleton. All Rights Reserved.