com.caplin.datasource.messaging

Enum MessageType

java.lang.Object

java.lang.Enum<MessageType>

com.caplin.datasource.messaging.MessageType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MessageType>

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

This class defines all the types of Message types that are supported by DataSource.

The available Message types are:

• Record
• Record Type 2
• Record Type 3
• Page
• News
• Story
• Container
• Permission
• Generic Object

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONTAINER
GENERIC
NEWS
PAGE
PERMISSION
RECORD
RECORD_TYPE2
RECORD_TYPE3
STORY
UNDEFINED
UNKNOWN

Method Summary

Modifier and Type	Method and Description
int	getCode() Gets the code that represents the Message's type.
static MessageType	toMessageType(int typeCode) Gets the MessageType that represents the specified code.
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

PAGE

public static final MessageType PAGE

RECORD

public static final MessageType RECORD

RECORD_TYPE2

public static final MessageType RECORD_TYPE2

RECORD_TYPE3

public static final MessageType RECORD_TYPE3

NEWS

public static final MessageType NEWS

STORY

public static final MessageType STORY

CONTAINER

public static final MessageType CONTAINER

PERMISSION

public static final MessageType PERMISSION

UNKNOWN

public static final MessageType UNKNOWN

GENERIC

public static final MessageType GENERIC

UNDEFINED

public static final MessageType UNDEFINED

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

toMessageType

public static MessageType toMessageType(int typeCode)

Gets the MessageType that represents the specified code.

The valid codes are:

• 221 - PAGE
• 222 - RECORD
• 223 - NEWS
• 224 - STORY
• 225 - RECORD_TYPE2
• 226 - RECORD_TYPE3
• 228 - CONTAINER
• 230 - PERMISSION
• 231 - GENERIC
• 200 - UNKNOWN
• -1 - UNDEFINED

Parameters:

typeCode - The code used to describe a Message type.

Returns:

The MessageType that corresponds to the specified code. If the code does not match any of the available MessageTypes, then null is returned.

getCode

public int getCode()

Gets the code that represents the Message's type.

Returns:

The Message's code.