package Torello.Browser.BrowserAPI;

// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// Java-HTML Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import Torello.Browser.*;
import Torello.Browser.helper.*;
import Torello.Browser.JavaScriptAPI.*;
import Torello.JSON.*;

import Torello.Java.ReadOnly.ReadOnlyList;
import Torello.Java.ReadOnly.ReadOnlyArrayList;

import Torello.JavaDoc.Annotations.StaticFunctional;
import Torello.JavaDoc.Annotations.JDHeaderBackgroundImg;

import Torello.Browser.BrowserAPI.NestedHelpers.Commands.Memory$$Commands;


// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***
// JDK Imports
// *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** *** ***

import javax.json.JsonObject;
import javax.json.JsonValue;

/**
 * <SPAN CLASS=COPIEDJDK><B><CODE>[No Description Provided by Google]</CODE></B></SPAN>
 * <EMBED CLASS='external-html' DATA-FILE-ID=CDP.CODE_GEN_NOTE>
 */
@StaticFunctional@JDHeaderBackgroundImg(EmbedTagFileID="CDP.WOOD_PLANK_NOTE")
public class Memory
{
    // No Pubic Constructors
    private Memory() { }


    // ********************************************************************************************
    // ********************************************************************************************
    // Enumerated String Constants Lists
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Memory pressure level.
     * <BR /><BR /><B CLASS=StrEnumType>String-Enumeration Type</B>
     */
    public static final ReadOnlyList<String> PressureLevel = new ReadOnlyArrayList<>
        (String.class, "critical", "moderate");



    // ********************************************************************************************
    // ********************************************************************************************
    // Basic Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * DOM object counter data.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Memory DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class DOMCounter
        extends BaseType<DOMCounter>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Memory.DOMCounter> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                Memory$$DOMCounter$$.singleton;

        /**
         * Object name. Note: object names should be presumed volatile and clients should not expect
         * the returned names to be consistent across runs.
         */
        public final String name;

        /** Object count. */
        public final int count;

        /** Constructor.  Please review this class' fields for documentation. */
        public DOMCounter(ReadOnlyList<Boolean> isPresent, String name, int count)
        {
            super(singleton, Domains.Memory, "DOMCounter", 2);

            this.name   = name;
            this.count  = count;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "Memory.DOMCounter");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static DOMCounter fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<DOMCounter> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * Executable module information
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Memory DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class Module
        extends BaseType<Module>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Memory.Module> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                Memory$$Module$$.singleton;

        /** Name of the module. */
        public final String name;

        /** UUID of the module. */
        public final String uuid;

        /**
         * Base address where the module is loaded into memory. Encoded as a decimal
         * or hexadecimal (0x prefixed) string.
         */
        public final String baseAddress;

        /** Size of the module in bytes. */
        public final Number size;

        /** Constructor.  Please review this class' fields for documentation. */
        public Module(
                ReadOnlyList<Boolean> isPresent, String name, String uuid, String baseAddress,
                Number size
            )
        {
            super(singleton, Domains.Memory, "Module", 4);

            this.name           = name;
            this.uuid           = uuid;
            this.baseAddress    = baseAddress;
            this.size           = size;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 4, "Memory.Module");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static Module fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<Module> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * Array of heap profile samples.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Memory DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class SamplingProfile
        extends BaseType<SamplingProfile>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Memory.SamplingProfile> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                Memory$$SamplingProfile$$.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Memory.SamplingProfileNode[] samples;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final Memory.Module[] modules;

        /** Constructor.  Please review this class' fields for documentation. */
        public SamplingProfile
            (ReadOnlyList<Boolean> isPresent, SamplingProfileNode[] samples, Module[] modules)
        {
            super(singleton, Domains.Memory, "SamplingProfile", 2);

            this.samples = samples;
            this.modules = modules;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 2, "Memory.SamplingProfile");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static SamplingProfile fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<SamplingProfile> descriptor()
        { return singleton.descriptor(); }
    }

    /**
     * Heap profile sample.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Memory DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_TYPE_JDHBI")
    public static class SamplingProfileNode
        extends BaseType<SamplingProfileNode>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Memory.SamplingProfileNode> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Types.
                Memory$$SamplingProfileNode$$.singleton;

        /** Size of the sampled allocation. */
        public final Number size;

        /** Total bytes attributed to this sample. */
        public final Number total;

        /** Execution stack at the point of allocation. */
        public final String[] stack;

        /** Constructor.  Please review this class' fields for documentation. */
        public SamplingProfileNode
            (ReadOnlyList<Boolean> isPresent, Number size, Number total, String[] stack)
        {
            super(singleton, Domains.Memory, "SamplingProfileNode", 3);

            this.size   = size;
            this.total  = total;
            this.stack  = stack;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 3, "Memory.SamplingProfileNode");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static SamplingProfileNode fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<SamplingProfileNode> descriptor()
        { return singleton.descriptor(); }
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Command-Return Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Retruns current DOM object counters.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Memory DATA-API=BrowserAPI DATA-CMD=getDOMCounters>
     * @see Memory#getDOMCounters
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_CMD_JDHBI")
    public static class getDOMCounters$$RET
        extends BaseType<getDOMCounters$$RET>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Memory.getDOMCounters$$RET> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.CmdReturns.
                Memory$$getDOMCounters$$RET.singleton;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final int documents;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final int nodes;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final int jsEventListeners;

        /** Constructor.  Please review this class' fields for documentation. */
        public getDOMCounters$$RET
            (ReadOnlyList<Boolean> isPresent, int documents, int nodes, int jsEventListeners)
        {
            super(singleton, Domains.Memory, "getDOMCounters", 3);

            this.documents          = documents;
            this.nodes              = nodes;
            this.jsEventListeners   = jsEventListeners;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 3, "Memory.getDOMCounters$$RET");
        }

        /** Creates an instance of this class from a {@link JsonObject}.*/
        public static getDOMCounters$$RET fromJSON(JsonObject jo)
        { return singleton.fromJSON(jo); }

        /** Returns this class's {@link NestedDescriptor} singleton-instance. class / type.*/
        public static NestedDescriptor<getDOMCounters$$RET> descriptor()
        { return singleton.descriptor(); }
    }




    // ********************************************************************************************
    // ********************************************************************************************
    // Commands
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Simulate OomIntervention by purging V8 memory.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&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 /><DIV CLASS=JDHint>
     * 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 <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> forciblyPurgeJavaScriptMemory()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Memory.forciblyPurgeJavaScriptMemory\"}";

        return Script.NO_RET(Domains.Memory, "forciblyPurgeJavaScriptMemory", requestJSON);
    }

    /**
     * Retrieve native memory allocations profile
     * collected since renderer process startup.
     * 
     * @return An instance of <CODE>{@link Script}&lt;{@link Memory.SamplingProfile}&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
     * <CODE>&lt;{@link Memory.SamplingProfile}&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
     * be retrieved.</I>
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser Function's {@code Promise} returns:
     * <CODE>{@link Memory.SamplingProfile} (<B>profile</B>)</CODE>
     * </DIV>
     */
    public static Script<Memory.SamplingProfile> getAllTimeSamplingProfile()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Memory.getAllTimeSamplingProfile\"}";

        return new Script<>(
            Domains.Memory, "getAllTimeSamplingProfile", requestJSON,
            Memory$$Commands::getAllTimeSamplingProfile,
            Memory.SamplingProfile.class
        );
    }

    /**
     * Retrieve native memory allocations profile
     * collected since browser process startup.
     * 
     * @return An instance of <CODE>{@link Script}&lt;{@link Memory.SamplingProfile}&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
     * <CODE>&lt;{@link Memory.SamplingProfile}&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
     * be retrieved.</I>
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser Function's {@code Promise} returns:
     * <CODE>{@link Memory.SamplingProfile} (<B>profile</B>)</CODE>
     * </DIV>
     */
    public static Script<Memory.SamplingProfile> getBrowserSamplingProfile()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Memory.getBrowserSamplingProfile\"}";

        return new Script<>(
            Domains.Memory, "getBrowserSamplingProfile", requestJSON,
            Memory$$Commands::getBrowserSamplingProfile,
            Memory.SamplingProfile.class
        );
    }

    /**
     * Retruns current DOM object counters.
     * 
     * @return An instance of <CODE>{@link Script}&lt;{@link getDOMCounters$$RET}&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
     * <CODE>&lt;{@link getDOMCounters$$RET}&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
     * be retrieved.</I>
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser Function's {@code Promise} returns:{@link getDOMCounters$$RET}
     * A dedicated return type implies that the browser may return more than 1 datum
     * </DIV>
     */
    public static Script<getDOMCounters$$RET> getDOMCounters()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Memory.getDOMCounters\"}";

        return new Script<>(
            Domains.Memory, "getDOMCounters", requestJSON,
            getDOMCounters$$RET::fromJSON,
            getDOMCounters$$RET.class
        );
    }

    /**
     * Retruns DOM object counters after preparing renderer for leak detection.
     * 
     * @return An instance of <CODE>{@link Script}&lt;{@link Memory.DOMCounter}[]&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
     * <CODE>&lt;{@link Memory.DOMCounter}[]&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
     * be retrieved.</I>
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser Function's {@code Promise} returns:
     * <CODE>{@link Memory.DOMCounter}[] (<B>counters</B>)</CODE>
     * <BR />
     * DOM object counters.
     * </DIV>
     */
    public static Script<Memory.DOMCounter[]> getDOMCountersForLeakDetection()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Memory.getDOMCountersForLeakDetection\"}";

        return new Script<>(
            Domains.Memory, "getDOMCountersForLeakDetection", requestJSON,
            Memory$$Commands::getDOMCountersForLeakDetection,
            Memory.DOMCounter[].class
        );
    }

    /**
     * Retrieve native memory allocations profile collected since last
     * <CODE>startSampling</CODE> call.
     * 
     * @return An instance of <CODE>{@link Script}&lt;{@link Memory.SamplingProfile}&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec(WebSocketSender) Script.exec}, and afterwards, a {@link Promise}
     * <CODE>&lt;{@link Memory.SamplingProfile}&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
     * be retrieved.</I>
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser Function's {@code Promise} returns:
     * <CODE>{@link Memory.SamplingProfile} (<B>profile</B>)</CODE>
     * </DIV>
     */
    public static Script<Memory.SamplingProfile> getSamplingProfile()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Memory.getSamplingProfile\"}";

        return new Script<>(
            Domains.Memory, "getSamplingProfile", requestJSON,
            Memory$$Commands::getSamplingProfile,
            Memory.SamplingProfile.class
        );
    }

    /**
     * Prepares for leak detection by terminating workers, stopping spellcheckers,
     * dropping non-essential internal caches, running garbage collections, etc.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&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 /><DIV CLASS=JDHint>
     * 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 <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> prepareForLeakDetection()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Memory.prepareForLeakDetection\"}";

        return Script.NO_RET(Domains.Memory, "prepareForLeakDetection", requestJSON);
    }

    /**
     * Enable/disable suppressing memory pressure notifications in all processes.
     * 
     * @param suppressed If true, memory pressure notifications will be suppressed.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&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 /><DIV CLASS=JDHint>
     * 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 <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> setPressureNotificationsSuppressed(boolean suppressed)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get(
            CDPTypes.PRIMITIVE_BOOLEAN, "suppressed", false,
            "Memory.setPressureNotificationsSuppressed", suppressed
        );

        return Script.NO_RET(Domains.Memory, "setPressureNotificationsSuppressed", requestJSON);
    }

    /**
     * Simulate a memory pressure notification in all processes.
     * 
     * @param level Memory pressure level of the notification.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&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 /><DIV CLASS=JDHint>
     * 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 <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> simulatePressureNotification(String level)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get
            (CDPTypes.STRING, "level", false, "Memory.simulatePressureNotification", level);

        return Script.NO_RET(Domains.Memory, "simulatePressureNotification", requestJSON);
    }

    /**
     * Start collecting native memory profile.
     * 
     * @param samplingInterval Average number of bytes between samples.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @param suppressRandomness Do not randomize intervals between samples.
     * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&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 /><DIV CLASS=JDHint>
     * 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 <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> startSampling(Integer samplingInterval, Boolean suppressRandomness)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            Memory$$Commands.startSampling$$, "Memory.startSampling",
            samplingInterval, suppressRandomness
        );

        return Script.NO_RET(Domains.Memory, "startSampling", requestJSON);
    }

    /**
     * Stop collecting native memory profile.
     * 
     * @return An instance of <CODE>{@link Script}&lt;Void&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 /><DIV CLASS=JDHint>
     * 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 <Void>} to ensure that
     * the Browser Function has run to completion.
     * </DIV>
     */
    public static Script<Void> stopSampling()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Memory.stopSampling\"}";

        return Script.NO_RET(Domains.Memory, "stopSampling", requestJSON);
    }


}