Package com.caplin.datasource.messaging

Enum Class MessageType

java.lang.Object
java.lang.Enum<MessageType>
com.caplin.datasource.messaging.MessageType
All Implemented Interfaces:
Serializable, Comparable<MessageType>, java.lang.constant.Constable
public enum MessageType extends 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 Details

  • Method Details

    • values

      public static MessageType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static MessageType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      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:

      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.

    • toString

      public String toString()
      Overrides:
      toString in class Enum<MessageType>