package Torello.Browser.JavaScriptAPI;

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

import Torello.Browser.*;
import Torello.Browser.helper.*;
import Torello.Browser.BrowserAPI.*;
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>This domain is deprecated - use RunTime or Log instead.</B></SPAN>
 * <EMBED CLASS='external-html' DATA-FILE-ID=CDP.CODE_GEN_NOTE>
 */
@StaticFunctional@JDHeaderBackgroundImg(EmbedTagFileID="CDP.WOOD_PLANK_NOTE")
public class Console
{
    // No Pubic Constructors
    private Console() { }



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


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

        private static final NestedHelper<Console.ConsoleMessage> singleton =
            Torello.Browser.JavaScriptAPI.NestedHelpers.Types.
                Console$$ConsoleMessage$$.singleton;

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

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

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

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

        /**
         * Line number in the resource that generated this message (1-based).
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final Integer line;

        /**
         * Column number in the resource that generated this message (1-based).
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final Integer column;

        /** Constructor.  Please review this class' fields for documentation. */
        public ConsoleMessage(
                ReadOnlyList<Boolean> isPresent, String source, String level, String text,
                String url, Integer line, Integer column
            )
        {
            super(singleton, Domains.Console, "ConsoleMessage", 6);

            this.source = source;
            this.level  = level;
            this.text   = text;
            this.url    = url;
            this.line   = line;
            this.column = column;

            this.isPresent = (isPresent == null)
                ? singleton.generateIsPresentList(this)
                : THROWS.check(isPresent, 6, "Console.ConsoleMessage");
        }

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

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


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


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

        private static final NestedHelper<Console.messageAdded> singleton =
            Torello.Browser.JavaScriptAPI.NestedHelpers.Events.
                Console$$messageAdded$$.singleton;

        /** Console message that has been added. */
        public final Console.ConsoleMessage message;

        /** Constructor.  Please review this class' fields for documentation. */
        public messageAdded(ReadOnlyList<Boolean> isPresent, ConsoleMessage message)
        {
            super(singleton, Domains.Console, "messageAdded", 1);

            this.message = message;

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

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

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




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


    /**
     * Does nothing.
     * 
     * @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> clearMessages()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"Console.clearMessages\"}";

        return Script.NO_RET(Domains.Console, "clearMessages", requestJSON);
    }

    /**
     * Disables console domain, prevents further console messages 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\":\"Console.disable\"}";

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

    /**
     * Enables console domain, sends the messages collected so far to the client by means of the
     * <CODE>messageAdded</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\":\"Console.enable\"}";

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


}