Package provided.owlMaps.cefUtils.gson

Class FuncParamsVoid

java.lang.Object
provided.owlMaps.cefUtils.gson.FuncParamsVoid
Direct Known Subclasses:
FuncParams
public class FuncParamsVoid
extends java.lang.Object
*** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS CLASS! ***
Input parameter encapsulation for void return function calls! 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.lang.Object[] params
    Internal storage of the variable parameters

  • Constructor Summary

    Constructors
    Constructor Description
    FuncParamsVoid​(java.lang.Object... params)
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS METHOD! ***
    Constructor for the class

  • Method Summary

    Modifier and Type Method Description
    java.lang.Object[] getParams()
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS METHOD! ***
    Getter for the encapsulated parameters
    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()  
    protected static void writeParams​(com.google.gson.Gson gson, com.google.gson.stream.JsonWriter out, FuncParamsVoid funcParams)
    *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS METHOD! ***
    Utility method to write the stored parameters out as JSON using the suppled JsonWriter.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • params

      private java.lang.Object[] params
      Internal storage of the variable parameters

  • Constructor Details

    • FuncParamsVoid

      public FuncParamsVoid​(java.lang.Object... params)
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS METHOD! ***
      Constructor for the class
      Parameters:
      params - Vararg of the parameters to encapsulate

  • Method Details

    • getParams

      public java.lang.Object[] getParams()
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS METHOD! ***
      Getter for the encapsulated parameters
      Returns:
      An array of parameters

    • toString

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

    • 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

    • writeParams

      protected static final void writeParams​(com.google.gson.Gson gson, com.google.gson.stream.JsonWriter out, FuncParamsVoid funcParams) throws java.io.IOException
      *** FOR INTERNAL USE ONLY!! DEVELOPER CODE SHOULD NEVER DIRECTLY USE THIS METHOD! ***
      Utility method to write the stored parameters out as JSON using the suppled JsonWriter. This utility is used the TypeAdapterFactories created by FuncParamsVoid and its subclasses.
      Parameters:
      gson - The GSON parser in use
      out - The JsonWriter JSON output formatter
      funcParams - The FuncParamsVoid or subclass that holds the parameters to process.
      Throws:
      java.io.IOException - if an error occurs while writing to the JsonWriter's output stream.