Class InputRequest


  • public class InputRequest
    extends Object
    Content of the `InputRequest` message. It conveys the data to display and how to process it. In addition to the display on the Input Device, it might contain an operation (the `DisplayOutput` element) per Display Device type.
    • Constructor Detail

      • InputRequest

        public InputRequest()
    • Method Detail

      • displayOutput

        public InputRequest displayOutput​(DisplayOutput displayOutput)
        displayOutput
        Parameters:
        displayOutput -
        Returns:
        the current InputRequest instance, allowing for method chaining
      • getDisplayOutput

        public DisplayOutput getDisplayOutput()
        Get displayOutput
        Returns:
        displayOutput
      • setDisplayOutput

        public void setDisplayOutput​(DisplayOutput displayOutput)
        displayOutput
        Parameters:
        displayOutput -
      • inputData

        public InputRequest inputData​(InputData inputData)
        inputData
        Parameters:
        inputData -
        Returns:
        the current InputRequest instance, allowing for method chaining
      • getInputData

        public InputData getInputData()
        Get inputData
        Returns:
        inputData
      • setInputData

        public void setInputData​(InputData inputData)
        inputData
        Parameters:
        inputData -
      • includeNullValues

        public InputRequest includeNullValues​(boolean includeNullValues)
        Configures whether null values are explicitly serialized in the JSON payload. Default is false.
      • isIncludeNullValues

        public boolean isIncludeNullValues()
        Returns whether null values are explicitly serialized in the JSON payload.
      • setIncludeNullValues

        public void setIncludeNullValues​(boolean includeNullValues)
        Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
      • equals

        public boolean equals​(Object o)
        Return true if this InputRequest object is equal to o.
        Overrides:
        equals in class Object
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • getExplicitNulls

        public Map<String,​Object> getExplicitNulls()
        Returns a map of properties to be merged into the JSON payload as explicit null values.
      • fromJson

        public static InputRequest fromJson​(String jsonString)
                                     throws com.fasterxml.jackson.core.JsonProcessingException
        Create an instance of InputRequest given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of InputRequest
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to InputRequest
      • toJson

        public String toJson()
                      throws com.fasterxml.jackson.core.JsonProcessingException
        Convert an instance of InputRequest to an JSON string
        Returns:
        JSON string
        Throws:
        com.fasterxml.jackson.core.JsonProcessingException