com.mooapi.common.message
Enum MessageType

java.lang.Object
  extended by java.lang.Enum<MessageType>
      extended by com.mooapi.common.message.MessageType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<MessageType>

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

MooAPI message type. This server currently handles the string, integer and binary types. It may handle the object (code 10) type in a future version.

Author:
Steve Taylor

Enum Constant Summary
BINARY
           
INTEGER
           
STRING
           
 
Method Summary
static MessageType decode(byte encoding)
          Decoded a message type byte, returning the message type or null if no match is found.
 byte encode()
          Get this message type's encoding.
static MessageType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static MessageType[] 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

STRING

public static final MessageType STRING

INTEGER

public static final MessageType INTEGER

BINARY

public static final MessageType BINARY
Method Detail

values

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

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

valueOf

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

encode

public byte encode()
Get this message type's encoding.

Returns:
The encoding.

decode

public static MessageType decode(byte encoding)
Decoded a message type byte, returning the message type or null if no match is found.

Parameters:
encoding - The type byte.
Returns:
The message type or null if no match was found.


Copyright © 2009. All Rights Reserved.