Package provided.owlMaps.cefUtils.gson

Class FuncParams

java.lang.Object
provided.owlMaps.cefUtils.gson.FuncParamsVoid
provided.owlMaps.cefUtils.gson.FuncParams
public class FuncParams
extends FuncParamsVoid
*** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS CLASS! ***
A FuncParamsVoid extended to handle function calls that have a return value. Enables the transmission of a request ID, which is needed for the return value callback. Enables the JSON conversion of a vararg of parameters into a JSON object with "params" key and JSON converted array of values.
Author:
swong

  • Field Summary

    Fields
    Modifier and Type Field Description
    private java.util.UUID requestID
    The request ID for this call

  • Constructor Summary

    Constructors
    Constructor Description
    FuncParams​(java.util.UUID requestID, java.lang.Object... params)
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS METHOD! ***
    Construct an instance with a given request ID value.

  • Method Summary

    Modifier and Type Method Description
    java.util.UUID getRequestID()
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS METHOD! ***
    Getter for the encapsulated request ID
    static com.google.gson.TypeAdapterFactory makeTypeAdapterFactory()
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS METHOD! ***
    Instantiate a GSON TypeAdapterFactory that will instantiate a TypeAdapter for this class.
    java.lang.String toString()  

    Methods inherited from class provided.owlMaps.cefUtils.gson.FuncParamsVoid

    getParams, writeParams

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

  • Field Details

    • requestID

      private java.util.UUID requestID
      The request ID for this call

  • Constructor Details

    • FuncParams

      public FuncParams​(java.util.UUID requestID, java.lang.Object... params)
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS METHOD! ***
      Construct an instance with a given request ID value.
      Parameters:
      requestID - The request ID for the call
      params - A vararg of parameters to encapsulate

  • Method Details

    • getRequestID

      public java.util.UUID getRequestID()
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS METHOD! ***
      Getter for the encapsulated request ID
      Returns:
      a UUID

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class FuncParamsVoid

    • makeTypeAdapterFactory

      public static com.google.gson.TypeAdapterFactory makeTypeAdapterFactory()
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS METHOD! ***
      Instantiate a GSON TypeAdapterFactory that will instantiate a TypeAdapter for this class. That TypeAdapter will redirect the JSON processing of the stored object back to the supplied Gson processor using the stored Class object.
      Returns:
      A new TypeAdapterFactory instance