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.Performance$$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 Performance
{
    // No Pubic Constructors
    private Performance() { }



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


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

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

        /** Metric name. */
        public final String name;

        /** Metric value. */
        public final Number value;

        /** Constructor.  Please review this class' fields for documentation. */
        public Metric(ReadOnlyList<Boolean> isPresent, String name, Number value)
        {
            super(singleton, Domains.Performance, "Metric", 2);

            this.name   = name;
            this.value  = value;

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

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

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


    // ********************************************************************************************
    // ********************************************************************************************
    // Event Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * Current values of the metrics.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Performance DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class metrics
        extends BrowserEvent<metrics>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

        private static final NestedHelper<Performance.metrics> singleton =
            Torello.Browser.BrowserAPI.NestedHelpers.Events.
                Performance$$metrics$$.singleton;

        /** Current values of the metrics. */
        public final Performance.Metric[] metrics;

        /** Timestamp title. */
        public final String title;

        /** Constructor.  Please review this class' fields for documentation. */
        public metrics(ReadOnlyList<Boolean> isPresent, Metric[] metrics, String title)
        {
            super(singleton, Domains.Performance, "metrics", 2);

            this.metrics    = metrics;
            this.title      = title;

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

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

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




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


    /**
     * Disable collecting and reporting metrics.
     * 
     * @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> disable()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Performance.disable\"}";

        return Script.NO_RET(Domains.Performance, "disable", requestJSON);
    }

    /**
     * Enable collecting and reporting metrics.
     * 
     * @param timeDomain Time domain to use for collecting and reporting duration metrics.
     * <BR />Acceptable Values: ["threadTicks", "timeTicks"]
     * <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> enable(String timeDomain)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get
            (CDPTypes.STRING, "timeDomain", true, "Performance.enable", timeDomain);

        return Script.NO_RET(Domains.Performance, "enable", requestJSON);
    }

    /**
     * Retrieve current values of run-time metrics.
     * 
     * @return An instance of <CODE>{@link Script}&lt;{@link Performance.Metric}[]&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 Performance.Metric}[]&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 Performance.Metric}[] (<B>metrics</B>)</CODE>
     * <BR />
     * Current values for run-time metrics.
     * </DIV>
     */
    public static Script<Performance.Metric[]> getMetrics()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Performance.getMetrics\"}";

        return new Script<>(
            Domains.Performance, "getMetrics", requestJSON,
            Performance$$Commands::getMetrics,
            Performance.Metric[].class
        );
    }

    /**
     * Sets time domain to use for collecting and reporting duration metrics.
     * Note that this must be called before enabling metrics collection. Calling
     * this method while metrics collection is enabled returns an error.
     * 
     * <BR /><B CLASS=Exp-Top>EXPERIMENTAL</B><B CLASS=Dep-Top>DEPRECATED</B>
     * 
     * @param timeDomain Time domain
     * <BR />Acceptable Values: ["threadTicks", "timeTicks"]
     * 
     * @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> setTimeDomain(String timeDomain)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get
            (CDPTypes.STRING, "timeDomain", false, "Performance.setTimeDomain", timeDomain);

        return Script.NO_RET(Domains.Performance, "setTimeDomain", requestJSON);
    }


}