Enum 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
    • 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:

        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 java.lang.String toString()
        Overrides:
        toString in class java.lang.Enum<MessageType>