Class RunTime.CustomPreview

    • Field Summary

       
      Serializable ID
      Modifier and Type Field
      protected static long serialVersionUID
      For Object Serialization.
       
      Type Properties
      Modifier and Type Field
      String bodyGetterId
      If formatter returns true as a result of formatter.hasBody call then bodyGetterId will contain RemoteObjectId for the function that returns result of formatter.body(object, config) call.
      String header
      The JSON-stringified result of formatter.header(object, config) call.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object other)
      Checks whether 'this' equals an input Java-Object
      int hashCode()
      Generates a Hash-Code for 'this' instance
      boolean[] optionals()
      Implementing this method allows sub-classes to specify which JSON Properties may be absent or null.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • header

        🡅  🡇     🗕  🗗  🗖
        public final java.lang.String header
        The JSON-stringified result of formatter.header(object, config) call. It contains json ML array that represents RemoteObject.
      • bodyGetterId

        🡅  🡇     🗕  🗗  🗖
        public final java.lang.String bodyGetterId
        If formatter returns true as a result of formatter.hasBody call then bodyGetterId will contain RemoteObjectId for the function that returns result of formatter.body(object, config) call. The result value is json ML array.

        OPTIONAL
    • Constructor Detail

      • CustomPreview

        🡅  🡇     🗕  🗗  🗖
        public CustomPreview​(java.lang.String header,
                             java.lang.String bodyGetterId)
        Constructor
        Parameters:
        header - The JSON-stringified result of formatter.header(object, config) call. It contains json ML array that represents RemoteObject.
        bodyGetterId - If formatter returns true as a result of formatter.hasBody call then bodyGetterId will contain RemoteObjectId for the function that returns result of formatter.body(object, config) call. The result value is json ML array.
        OPTIONAL
    • Method Detail

      • optionals

        🡅  🡇     🗕  🗗  🗖
        public boolean[] optionals()
        Description copied from class: BaseType
        Implementing this method allows sub-classes to specify which JSON Properties may be absent or null. When binding a JsonObject to a Java-Object, if some of the expected fields for the Java-Object map to Properties which might be left-out or omitted, then that may be indicated by setting that fields array position TRUE.

        NOTE: This array should have a length equal to the number of fields contained by the Java Object. The first boolean in the array should specify whether the first Object Field may by absent. The second boolean should specify whether the second Object Field is optional in the JSON - and so on and so forth...
        Specified by:
        optionals in class BaseType
        Returns:
        A boolean[] array whose length is precisely equal to the number of fields in the Java Object.
      • equals

        🡅  🡇     🗕  🗗  🗖
        public boolean equals​(java.lang.Object other)
        Checks whether 'this' equals an input Java-Object
        Overrides:
        equals in class java.lang.Object
      • hashCode

        🡅     🗕  🗗  🗖
        public int hashCode()
        Generates a Hash-Code for 'this' instance
        Overrides:
        hashCode in class java.lang.Object