Package com.caplin.streamlink

Enum PayloadType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<PayloadType>
    public enum PayloadType
extends java.lang.Enum<PayloadType>

    Enumeration defining the types of payload used on commands

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      JSON
      The payload should be an object that can be serialized to JSON.
      RECORD
      The payload should be a map of field names to values or a list of name, value tuples.
      SUBJECT_TYPE
      The payload should be of type SubjectType.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static PayloadType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static PayloadType[] 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

      • SUBJECT_TYPE

        public static final PayloadType SUBJECT_TYPE

        The payload should be of type SubjectType.

      • RECORD

        public static final PayloadType RECORD

        The payload should be a map of field names to values or a list of name, value tuples.

      • JSON

        public static final PayloadType JSON

        The payload should be an object that can be serialized to JSON.

    • Method Detail

      • values

        public static PayloadType[] 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 (PayloadType c : PayloadType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

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