package Torello.Browser;

import java.util.*;
import javax.json.*;
import javax.json.stream.*;
import java.io.*;

import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.function.Function;

import Torello.Java.Additional.*;

import static Torello.Java.Additional.JFlag.*;

import Torello.Java.StrCmpr;
import Torello.JavaDoc.StaticFunctional;
import Torello.JavaDoc.JDHeaderBackgroundImg;
import Torello.JavaDoc.Excuse;

/**
 * <SPAN CLASS=CopiedJDK><B><CODE>[No Description Provided by Google]</CODE></B></SPAN>
 * 
 * <EMBED CLASS='external-html' DATA-FILE-ID=CODE_GEN_NOTE>
 */
@StaticFunctional(Excused={"counter"}, Excuses={Excuse.CONFIGURATION})
@JDHeaderBackgroundImg(EmbedTagFileID="WOOD_PLANK_NOTE")
public class HeapProfiler
{
    // ********************************************************************************************
    // ********************************************************************************************
    // Class Header Stuff
    // ********************************************************************************************
    // ********************************************************************************************


    // No Pubic Constructors
    private HeapProfiler () { }

    // These two Vector's are used by all the "Methods" exported by this class.  java.lang.reflect
    // is used to generate the JSON String's.  It saves thousands of lines of Auto-Generated Code.
    private static final Map<String, Vector<String>>    parameterNames = new HashMap<>();
    private static final Map<String, Vector<Class<?>>>  parameterTypes = new HashMap<>();

    // Some Methods do not take any parameters - for instance all the "enable()" and "disable()"
    // I simply could not get ride of RAW-TYPES and UNCHECKED warnings... so there are now,
    // offically, two empty-vectors.  One for String's, and the other for Classes.

    private static final Vector<String>     EMPTY_VEC_STR = new Vector<>();
    private static final Vector<Class<?>>   EMPTY_VEC_CLASS = new Vector<>();

    static
    {
        for (Method m : HeapProfiler.class.getMethods())
        {
            // This doesn't work!  The parameter names are all "arg0" ... "argN"
            // It works for java.lang.reflect.Field, BUT NOT java.lang.reflect.Parameter!
            //
            // Vector<String> parameterNamesList = new Vector<>(); -- NOPE!

            Vector<Class<?>> parameterTypesList = new Vector<>();
        
            for (Parameter p : m.getParameters()) parameterTypesList.add(p.getType());

            parameterTypes.put(
                m.getName(),
                (parameterTypesList.size() > 0) ? parameterTypesList : EMPTY_VEC_CLASS
            );
        }
    }

    static
    {
        Vector<String> v = null;

        v = new Vector<String>(1);
        parameterNames.put("addInspectedHeapObject", v);
        Collections.addAll(v, new String[]
        { "heapObjectId", });

        parameterNames.put("collectGarbage", EMPTY_VEC_STR);

        parameterNames.put("disable", EMPTY_VEC_STR);

        parameterNames.put("enable", EMPTY_VEC_STR);

        v = new Vector<String>(1);
        parameterNames.put("getHeapObjectId", v);
        Collections.addAll(v, new String[]
        { "objectId", });

        v = new Vector<String>(2);
        parameterNames.put("getObjectByHeapObjectId", v);
        Collections.addAll(v, new String[]
        { "objectId", "objectGroup", });

        parameterNames.put("getSamplingProfile", EMPTY_VEC_STR);

        v = new Vector<String>(1);
        parameterNames.put("startSampling", v);
        Collections.addAll(v, new String[]
        { "samplingInterval", });

        v = new Vector<String>(1);
        parameterNames.put("startTrackingHeapObjects", v);
        Collections.addAll(v, new String[]
        { "trackAllocations", });

        parameterNames.put("stopSampling", EMPTY_VEC_STR);

        v = new Vector<String>(3);
        parameterNames.put("stopTrackingHeapObjects", v);
        Collections.addAll(v, new String[]
        { "reportProgress", "treatGlobalObjectsAsRoots", "captureNumericValue", });

        v = new Vector<String>(3);
        parameterNames.put("takeHeapSnapshot", v);
        Collections.addAll(v, new String[]
        { "reportProgress", "treatGlobalObjectsAsRoots", "captureNumericValue", });
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Types - Static Inner Classes
    // ********************************************************************************************
    // ********************************************************************************************

    // public static class HeapSnapshotObjectId => String
    
    /** Sampling Heap Profile node. Holds callsite information, allocation statistics and child nodes. */
    public static class SamplingHeapProfileNode extends BaseType
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, false, false, }; }
        
        /** Function location. */
        public final RunTime.CallFrame callFrame;
        
        /** Allocations size in bytes for the node excluding children. */
        public final Number selfSize;
        
        /** Node id. Ids are unique across all profiles collected between startSampling and stopSampling. */
        public final int id;
        
        /** Child nodes. */
        public final HeapProfiler.SamplingHeapProfileNode[] children;
        
        /**
         * Constructor
         *
         * @param callFrame Function location.
         * 
         * @param selfSize Allocations size in bytes for the node excluding children.
         * 
         * @param id Node id. Ids are unique across all profiles collected between startSampling and stopSampling.
         * 
         * @param children Child nodes.
         */
        public SamplingHeapProfileNode(
                RunTime.CallFrame callFrame, Number selfSize, int id, 
                HeapProfiler.SamplingHeapProfileNode[] children
            )
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (callFrame == null) BRDPC.throwNPE("callFrame");
            if (selfSize == null)  BRDPC.throwNPE("selfSize");
            if (children == null)  BRDPC.throwNPE("children");
            
            this.callFrame  = callFrame;
            this.selfSize   = selfSize;
            this.id         = id;
            this.children   = children;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'SamplingHeapProfileNode'}.
         */
        public SamplingHeapProfileNode (JsonObject jo)
        {
            this.callFrame  = ReadJSON.XL.getObject(jo, "callFrame", RunTime.CallFrame.class, false, true);
            this.selfSize   = ReadJSON.getNUMBER(jo, "selfSize", false, true);
            this.id         = ReadJSON.getInt(jo, "id");
            this.children   = (jo.getJsonArray("children") == null)
            ? null
            : ReadArrJSON.DimN.objArr(jo.getJsonArray("children"), null, 0, HeapProfiler.SamplingHeapProfileNode[].class);
        }
        
    }
    
    /** A single sample from a sampling profile. */
    public static class SamplingHeapProfileSample extends BaseType
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, false, }; }
        
        /** Allocation size in bytes attributed to the sample. */
        public final Number size;
        
        /** Id of the corresponding profile tree node. */
        public final int nodeId;
        
        /**
         * Time-ordered sample ordinal number. It is unique across all profiles retrieved
         * between startSampling and stopSampling.
         */
        public final Number ordinal;
        
        /**
         * Constructor
         *
         * @param size Allocation size in bytes attributed to the sample.
         * 
         * @param nodeId Id of the corresponding profile tree node.
         * 
         * @param ordinal 
         * Time-ordered sample ordinal number. It is unique across all profiles retrieved
         * between startSampling and stopSampling.
         */
        public SamplingHeapProfileSample(Number size, int nodeId, Number ordinal)
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (size == null)    BRDPC.throwNPE("size");
            if (ordinal == null) BRDPC.throwNPE("ordinal");
            
            this.size     = size;
            this.nodeId   = nodeId;
            this.ordinal  = ordinal;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'SamplingHeapProfileSample'}.
         */
        public SamplingHeapProfileSample (JsonObject jo)
        {
            this.size     = ReadJSON.getNUMBER(jo, "size", false, true);
            this.nodeId   = ReadJSON.getInt(jo, "nodeId");
            this.ordinal  = ReadJSON.getNUMBER(jo, "ordinal", false, true);
        }
        
    }
    
    /** Sampling profile. */
    public static class SamplingHeapProfile extends BaseType
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, }; }
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final HeapProfiler.SamplingHeapProfileNode head;
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final HeapProfiler.SamplingHeapProfileSample[] samples;
        
        /**
         * Constructor
         *
         * @param head -
         * 
         * @param samples -
         */
        public SamplingHeapProfile(
                HeapProfiler.SamplingHeapProfileNode head, 
                HeapProfiler.SamplingHeapProfileSample[] samples
            )
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (head == null)    BRDPC.throwNPE("head");
            if (samples == null) BRDPC.throwNPE("samples");
            
            this.head     = head;
            this.samples  = samples;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'SamplingHeapProfile'}.
         */
        public SamplingHeapProfile (JsonObject jo)
        {
            this.head     = ReadJSON.XL.getObject(jo, "head", HeapProfiler.SamplingHeapProfileNode.class, false, true);
            this.samples  = (jo.getJsonArray("samples") == null)
            ? null
            : ReadArrJSON.DimN.objArr(jo.getJsonArray("samples"), null, 0, HeapProfiler.SamplingHeapProfileSample[].class);
        }
        
    }
    
    /**
     * -
     *
     * <BR /><BR />This is Marker-Event.  Marker-Event's are Events that do not posses
     * any data, fields or state.  When they are fired, only the event name is supplied.
     */
    public static class resetProfiles extends BrowserEvent
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
    
        public boolean[] optionals() { return new boolean[0]; }
    
        /** JSON Object Constructor */
        public resetProfiles(JsonObject jo)
        { super("HeapProfiler", "resetProfiles", 0); }
    
        @Override
        public String toString() { return "HeapProfiler.resetProfiles Marker Event\n"; }
    }
    
    /** <CODE>[No Description Provided by Google]</CODE> */
    public static class addHeapSnapshotChunk extends BrowserEvent
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, }; }
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String chunk;
        
        /**
         * Constructor
         *
         * @param chunk -
         */
        public addHeapSnapshotChunk(String chunk)
        {
            super("HeapProfiler", "addHeapSnapshotChunk", 1);
            
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (chunk == null) BRDPC.throwNPE("chunk");
            
            this.chunk  = chunk;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'addHeapSnapshotChunk'}.
         */
        public addHeapSnapshotChunk (JsonObject jo)
        {
            super("HeapProfiler", "addHeapSnapshotChunk", 1);
        
            this.chunk  = ReadJSON.getString(jo, "chunk", false, true);
        }
        
    }
    
    /** If heap objects tracking has been started then backend may send update for one or more fragments */
    public static class heapStatsUpdate extends BrowserEvent
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, }; }
        
        /**
         * An array of triplets. Each triplet describes a fragment. The first integer is the fragment
         * index, the second integer is a total count of objects for the fragment, the third integer is
         * a total size of the objects for the fragment.
         */
        public final int[] statsUpdate;
        
        /**
         * Constructor
         *
         * @param statsUpdate 
         * An array of triplets. Each triplet describes a fragment. The first integer is the fragment
         * index, the second integer is a total count of objects for the fragment, the third integer is
         * a total size of the objects for the fragment.
         */
        public heapStatsUpdate(int[] statsUpdate)
        {
            super("HeapProfiler", "heapStatsUpdate", 1);
            
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (statsUpdate == null) BRDPC.throwNPE("statsUpdate");
            
            this.statsUpdate  = statsUpdate;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'heapStatsUpdate'}.
         */
        public heapStatsUpdate (JsonObject jo)
        {
            super("HeapProfiler", "heapStatsUpdate", 1);
        
            this.statsUpdate  = (jo.getJsonArray("statsUpdate") == null)
            ? null
            : ReadArrJSON.DimN.intArr(jo.getJsonArray("statsUpdate"), -1, 0, null, int[].class);;
        }
        
    }
    
    /**
     * If heap objects tracking has been started then backend regularly sends a current value for last
     * seen object id and corresponding timestamp. If the were changes in the heap since last event
     * then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event.
     */
    public static class lastSeenObjectId extends BrowserEvent
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, }; }
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final int lastSeenObjectId;
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Number timestamp;
        
        /**
         * Constructor
         *
         * @param lastSeenObjectId -
         * 
         * @param timestamp -
         */
        public lastSeenObjectId(int lastSeenObjectId, Number timestamp)
        {
            super("HeapProfiler", "lastSeenObjectId", 2);
            
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (timestamp == null) BRDPC.throwNPE("timestamp");
            
            this.lastSeenObjectId  = lastSeenObjectId;
            this.timestamp         = timestamp;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'lastSeenObjectId'}.
         */
        public lastSeenObjectId (JsonObject jo)
        {
            super("HeapProfiler", "lastSeenObjectId", 2);
        
            this.lastSeenObjectId  = ReadJSON.getInt(jo, "lastSeenObjectId");
            this.timestamp         = ReadJSON.getNUMBER(jo, "timestamp", false, true);
        }
        
    }
    
    /** <CODE>[No Description Provided by Google]</CODE> */
    public static class reportHeapSnapshotProgress extends BrowserEvent
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, true, }; }
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final int done;
        
        /** <CODE>[No Description Provided by Google]</CODE> */
        public final int total;
        
        /**
         * <CODE>[No Description Provided by Google]</CODE>
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Boolean finished;
        
        /**
         * Constructor
         *
         * @param done -
         * 
         * @param total -
         * 
         * @param finished -
         * <BR /><B>OPTIONAL</B>
         */
        public reportHeapSnapshotProgress(int done, int total, Boolean finished)
        {
            super("HeapProfiler", "reportHeapSnapshotProgress", 3);
            
            this.done      = done;
            this.total     = total;
            this.finished  = finished;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'reportHeapSnapshotProgress'}.
         */
        public reportHeapSnapshotProgress (JsonObject jo)
        {
            super("HeapProfiler", "reportHeapSnapshotProgress", 3);
        
            this.done      = ReadJSON.getInt(jo, "done");
            this.total     = ReadJSON.getInt(jo, "total");
            this.finished  = ReadJSON.getBOOLEAN(jo, "finished", true);
        }
        
    }
    
    
    // Counter for keeping the WebSocket Request ID's distinct.
    private static int counter = 1;
    
    /**
     * Enables console to refer to the node with given id via $x (see Command Line API for more details
     * $x functions).
     * 
     * @param heapObjectId Heap snapshot object id to be accessible by means of $x command line API.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR />This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> addInspectedHeapObject(String heapObjectId)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (heapObjectId == null) BRDPC.throwNPE("heapObjectId");
        
        final int       webSocketID = 3000000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("addInspectedHeapObject"),
            parameterNames.get("addInspectedHeapObject"),
            optionals, webSocketID,
            "HeapProfiler.addInspectedHeapObject",
            heapObjectId
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR />This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> collectGarbage()
    {
        final int          webSocketID = 3001000 + counter++;
        final boolean[]    optionals   = new boolean[0];
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("collectGarbage"),
            parameterNames.get("collectGarbage"),
            optionals, webSocketID,
            "HeapProfiler.collectGarbage"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR />This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> disable()
    {
        final int          webSocketID = 3002000 + counter++;
        final boolean[]    optionals   = new boolean[0];
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("disable"),
            parameterNames.get("disable"),
            optionals, webSocketID,
            "HeapProfiler.disable"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR />This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> enable()
    {
        final int          webSocketID = 3003000 + counter++;
        final boolean[]    optionals   = new boolean[0];
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("enable"),
            parameterNames.get("enable"),
            optionals, webSocketID,
            "HeapProfiler.enable"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param objectId Identifier of the object to get heap object id for.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * String&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * String&gt;</CODE> will be returned.
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>String (<B>heapSnapshotObjectId</B></CODE>)
     *     <BR />Id of the heap snapshot object corresponding to the passed remote object id.
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, String> getHeapObjectId(String objectId)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (objectId == null) BRDPC.throwNPE("objectId");
        
        final int       webSocketID = 3004000 + counter++;
        final boolean[] optionals   = { false, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("getHeapObjectId"),
            parameterNames.get("getHeapObjectId"),
            optionals, webSocketID,
            "HeapProfiler.getHeapObjectId",
            objectId
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'String'
        Function<JsonObject, String> responseProcessor = (JsonObject jo) ->
            ReadJSON.getString(jo, "heapSnapshotObjectId", false, true);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param objectId -
     * 
     * @param objectGroup Symbolic group name that can be used to release multiple objects.
     * <BR /><B>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link RunTime.RemoteObject}&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * {@link RunTime.RemoteObject}&gt;</CODE> will be returned.
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>{@link RunTime.RemoteObject} (<B>result</B></CODE>)
     *     <BR />Evaluation result.
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, RunTime.RemoteObject> getObjectByHeapObjectId
        (String objectId, String objectGroup)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (objectId == null) BRDPC.throwNPE("objectId");
        
        final int       webSocketID = 3005000 + counter++;
        final boolean[] optionals   = { false, true, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("getObjectByHeapObjectId"),
            parameterNames.get("getObjectByHeapObjectId"),
            optionals, webSocketID,
            "HeapProfiler.getObjectByHeapObjectId",
            objectId, objectGroup
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'RunTime.RemoteObject'
        Function<JsonObject, RunTime.RemoteObject> responseProcessor = (JsonObject jo) ->
            ReadJSON.XL.getObject(jo, "result", RunTime.RemoteObject.class, false, true);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link HeapProfiler.SamplingHeapProfile}&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * {@link HeapProfiler.SamplingHeapProfile}&gt;</CODE> will be returned.
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>{@link HeapProfiler.SamplingHeapProfile} (<B>profile</B></CODE>)
     *     <BR />Return the sampling profile being collected.
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, HeapProfiler.SamplingHeapProfile> getSamplingProfile()
    {
        final int          webSocketID = 3006000 + counter++;
        final boolean[]    optionals   = new boolean[0];
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("getSamplingProfile"),
            parameterNames.get("getSamplingProfile"),
            optionals, webSocketID,
            "HeapProfiler.getSamplingProfile"
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'HeapProfiler.SamplingHeapProfile'
        Function<JsonObject, HeapProfiler.SamplingHeapProfile> responseProcessor = (JsonObject jo) ->
            ReadJSON.XL.getObject(jo, "profile", HeapProfiler.SamplingHeapProfile.class, false, true);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param samplingInterval 
     * Average sample interval in bytes. Poisson distribution is used for the intervals. The
     * default value is 32768 bytes.
     * <BR /><B>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR />This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> startSampling(Number samplingInterval)
    {
        final int       webSocketID = 3007000 + counter++;
        final boolean[] optionals   = { true, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("startSampling"),
            parameterNames.get("startSampling"),
            optionals, webSocketID,
            "HeapProfiler.startSampling",
            samplingInterval
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param trackAllocations -
     * <BR /><B>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR />This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> startTrackingHeapObjects
        (Boolean trackAllocations)
    {
        final int       webSocketID = 3008000 + counter++;
        final boolean[] optionals   = { true, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("startTrackingHeapObjects"),
            parameterNames.get("startTrackingHeapObjects"),
            optionals, webSocketID,
            "HeapProfiler.startTrackingHeapObjects",
            trackAllocations
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link HeapProfiler.SamplingHeapProfile}&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * {@link HeapProfiler.SamplingHeapProfile}&gt;</CODE> will be returned.
     *
     * <BR /><BR />Finally, the <B>{@code Promise}</B> may be <B STYLE='color: red'>awaited</B>,
     * using {@link Promise#await()}, <I>and the returned result of this Browser Function may
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>{@link HeapProfiler.SamplingHeapProfile} (<B>profile</B></CODE>)
     *     <BR />Recorded sampling heap profile.
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, HeapProfiler.SamplingHeapProfile> stopSampling()
    {
        final int          webSocketID = 3009000 + counter++;
        final boolean[]    optionals   = new boolean[0];
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("stopSampling"),
            parameterNames.get("stopSampling"),
            optionals, webSocketID,
            "HeapProfiler.stopSampling"
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'HeapProfiler.SamplingHeapProfile'
        Function<JsonObject, HeapProfiler.SamplingHeapProfile> responseProcessor = (JsonObject jo) ->
            ReadJSON.XL.getObject(jo, "profile", HeapProfiler.SamplingHeapProfile.class, false, true);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param reportProgress 
     * If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken
     * when the tracking is stopped.
     * <BR /><B>OPTIONAL</B>
     * 
     * @param treatGlobalObjectsAsRoots -
     * <BR /><B>OPTIONAL</B>
     * 
     * @param captureNumericValue If true, numerical values are included in the snapshot
     * <BR /><B>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR />This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> stopTrackingHeapObjects
        (Boolean reportProgress, Boolean treatGlobalObjectsAsRoots, Boolean captureNumericValue)
    {
        final int       webSocketID = 3010000 + counter++;
        final boolean[] optionals   = { true, true, true, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("stopTrackingHeapObjects"),
            parameterNames.get("stopTrackingHeapObjects"),
            optionals, webSocketID,
            "HeapProfiler.stopTrackingHeapObjects",
            reportProgress, treatGlobalObjectsAsRoots, captureNumericValue
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param reportProgress If true 'reportHeapSnapshotProgress' events will be generated while snapshot is being taken.
     * <BR /><B>OPTIONAL</B>
     * 
     * @param treatGlobalObjectsAsRoots If true, a raw snapshot without artificial roots will be generated
     * <BR /><B>OPTIONAL</B>
     * 
     * @param captureNumericValue If true, numerical values are included in the snapshot
     * <BR /><B>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&gt;</CODE>
     *
     * <BR /><BR />This {@code Script} instance must be <B STYLE='color:red'>executed</B> before the
     * browser receives the invocation-request.
     *
     * <BR /><BR />This Browser-Function <I>does not have</I> a return-value.  You may choose to
     * <B STYLE='color: red'>await</B> the {@link Promise}{@code <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> takeHeapSnapshot
        (Boolean reportProgress, Boolean treatGlobalObjectsAsRoots, Boolean captureNumericValue)
    {
        final int       webSocketID = 3011000 + counter++;
        final boolean[] optionals   = { true, true, true, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("takeHeapSnapshot"),
            parameterNames.get("takeHeapSnapshot"),
            optionals, webSocketID,
            "HeapProfiler.takeHeapSnapshot",
            reportProgress, treatGlobalObjectsAsRoots, captureNumericValue
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
}