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;


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

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

/**
 * <SPAN CLASS=COPIEDJDK><B>Provides access to log entries.</B></SPAN>
 * <EMBED CLASS='external-html' DATA-FILE-ID=CDP.CODE_GEN_NOTE>
 */
@StaticFunctional@JDHeaderBackgroundImg(EmbedTagFileID="CDP.WOOD_PLANK_NOTE")
public class Log
{
    // No Pubic Constructors
    private Log() { }



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


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

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

        /**
         * Log entry source.
         * <EMBED CLASS='external-html' DATA-D=Log DATA-C=LogEntry DATA-F=source DATA-FILE-ID=CDP.EL1>
         * @see BaseType#enumStrList(String)
         */
        public final String source;

        /**
         * Log entry severity.
         * <EMBED CLASS='external-html' DATA-D=Log DATA-C=LogEntry DATA-F=level DATA-FILE-ID=CDP.EL1>
         * @see BaseType#enumStrList(String)
         */
        public final String level;

        /** Logged text. */
        public final String text;

        /**
         * <CODE>[No Description Provided by Google]</CODE>
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         * <EMBED CLASS='external-html' DATA-D=Log DATA-C=LogEntry DATA-F=category DATA-FILE-ID=CDP.EL1>
         * @see BaseType#enumStrList(String)
         */
        public final String category;

        /** Timestamp when this entry was added. */
        public final Number timestamp;

        /**
         * URL of the resource if known.
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final String url;

        /**
         * Line number in the resource.
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final Integer lineNumber;

        /**
         * JavaScript stack trace.
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final RunTime.StackTrace stackTrace;

        /**
         * Identifier of the network request associated with this entry.
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final String networkRequestId;

        /**
         * Identifier of the worker associated with this entry.
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final String workerId;

        /**
         * Call arguments.
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final RunTime.RemoteObject[] args;

        /** Constructor.  Please review this class' fields for documentation. */
        public LogEntry(
                ReadOnlyList<Boolean> isPresent, String source, String level, String text,
                String category, Number timestamp, String url, Integer lineNumber,
                RunTime.StackTrace stackTrace, String networkRequestId, String workerId,
                RunTime.RemoteObject[] args
            )
        {
            super(singleton, Domains.Log, "LogEntry", 11);

            this.source             = source;
            this.level              = level;
            this.text               = text;
            this.category           = category;
            this.timestamp          = timestamp;
            this.url                = url;
            this.lineNumber         = lineNumber;
            this.stackTrace         = stackTrace;
            this.networkRequestId   = networkRequestId;
            this.workerId           = workerId;
            this.args               = args;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 11, "Log.LogEntry");
        }

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

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

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

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

        /**
         * Violation type.
         * <EMBED CLASS='external-html' DATA-D=Log DATA-C=ViolationSetting DATA-F=name DATA-FILE-ID=CDP.EL1>
         * @see BaseType#enumStrList(String)
         */
        public final String name;

        /** Time threshold to trigger upon. */
        public final Number threshold;

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

            this.name       = name;
            this.threshold  = threshold;

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

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

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


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


    /**
     * Issued when new message was logged.
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=Log DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class entryAdded
        extends BrowserEvent<entryAdded>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

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

        /** The entry. */
        public final Log.LogEntry entry;

        /** Constructor.  Please review this class' fields for documentation. */
        public entryAdded(ReadOnlyList<Boolean> isPresent, LogEntry entry)
        {
            super(singleton, Domains.Log, "entryAdded", 1);

            this.entry = entry;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 1, "Log.entryAdded");
        }

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

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




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


    /**
     * Clears the log.
     * 
     * @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> clear()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Log.clear\"}";

        return Script.NO_RET(Domains.Log, "clear", requestJSON);
    }

    /**
     * Disables log domain, prevents further log entries from being reported to the client.
     * 
     * @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\":\"Log.disable\"}";

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

    /**
     * Enables log domain, sends the entries collected so far to the client by means of the
     * <CODE>entryAdded</CODE> 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> enable()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Log.enable\"}";

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

    /**
     * start violation reporting.
     * 
     * @param config Configuration for violations.
     * 
     * @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> startViolationsReport(ViolationSetting[] config)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get(
            CDPTypes.CDP_TYPE_ARRAY_1D, "config", false, "Log.startViolationsReport", (Object)
            config
        );

        return Script.NO_RET(Domains.Log, "startViolationsReport", requestJSON);
    }

    /**
     * Stop violation reporting.
     * 
     * @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> stopViolationsReport()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Log.stopViolationsReport\"}";

        return Script.NO_RET(Domains.Log, "stopViolationsReport", requestJSON);
    }


}