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.DOMStorage$$Commands;


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

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

/**
 * <SPAN CLASS=COPIEDJDK><B>Query and modify DOM storage.</B></SPAN>
 * <EMBED CLASS='external-html' DATA-FILE-ID=CDP.CODE_GEN_NOTE>
 */
@StaticFunctional@JDHeaderBackgroundImg(EmbedTagFileID="CDP.WOOD_PLANK_NOTE")
public class DOMStorage
{
    // No Pubic Constructors
    private DOMStorage() { }


    // ********************************************************************************************
    // ********************************************************************************************
    // Eliminated Types
    // ********************************************************************************************
    // ********************************************************************************************


    /**
     * DOM Storage item.

     * <EMBED CLASS='external-html' DATA-CTAS='String' DATA-FILE-ID=CDP.EliminatedType
     *     DATA-NAME=Item>
     */
    public static final String Item =
        "Item has been eliminated.\n" +
        "It was replaced with the standard Java-Type: String";

    /**
     * <CODE>[No Description Provided by Google]</CODE>

     * <EMBED CLASS='external-html' DATA-CTAS='String' DATA-FILE-ID=CDP.EliminatedType
     *     DATA-NAME=SerializedStorageKey>
     */
    public static final String SerializedStorageKey =
        "SerializedStorageKey has been eliminated.\n" +
        "It was replaced with the standard Java-Type: String";



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


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

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

        /**
         * Security origin for the storage.
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final String securityOrigin;

        /**
         * Represents a key by which DOM Storage keys its CachedStorageAreas
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final String storageKey;

        /** Whether the storage is local storage (not session storage). */
        public final boolean isLocalStorage;

        /** Constructor.  Please review this class' fields for documentation. */
        public StorageId(
                ReadOnlyList<Boolean> isPresent, String securityOrigin, String storageKey,
                boolean isLocalStorage
            )
        {
            super(singleton, Domains.DOMStorage, "StorageId", 3);

            this.securityOrigin = securityOrigin;
            this.storageKey     = storageKey;
            this.isLocalStorage = isLocalStorage;

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

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

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


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


    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=DOMStorage DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class domStorageItemAdded
        extends BrowserEvent<domStorageItemAdded>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

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

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final DOMStorage.StorageId storageId;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String key;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String newValue;

        /** Constructor.  Please review this class' fields for documentation. */
        public domStorageItemAdded
            (ReadOnlyList<Boolean> isPresent, StorageId storageId, String key, String newValue)
        {
            super(singleton, Domains.DOMStorage, "domStorageItemAdded", 3);

            this.storageId  = storageId;
            this.key        = key;
            this.newValue   = newValue;

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

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

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

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=DOMStorage DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class domStorageItemRemoved
        extends BrowserEvent<domStorageItemRemoved>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

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

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final DOMStorage.StorageId storageId;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String key;

        /** Constructor.  Please review this class' fields for documentation. */
        public domStorageItemRemoved
            (ReadOnlyList<Boolean> isPresent, StorageId storageId, String key)
        {
            super(singleton, Domains.DOMStorage, "domStorageItemRemoved", 2);

            this.storageId  = storageId;
            this.key        = key;

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

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

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

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=DOMStorage DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class domStorageItemUpdated
        extends BrowserEvent<domStorageItemUpdated>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

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

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final DOMStorage.StorageId storageId;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String key;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String oldValue;

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final String newValue;

        /** Constructor.  Please review this class' fields for documentation. */
        public domStorageItemUpdated(
                ReadOnlyList<Boolean> isPresent, StorageId storageId, String key, String oldValue,
                String newValue
            )
        {
            super(singleton, Domains.DOMStorage, "domStorageItemUpdated", 4);

            this.storageId  = storageId;
            this.key        = key;
            this.oldValue   = oldValue;
            this.newValue   = newValue;

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

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

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

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * <EMBED CLASS=globalDefs DATA-DOMAIN=DOMStorage DATA-API=BrowserAPI>
     */
    @JDHeaderBackgroundImg(EmbedTagFileID="CDP.NESTED_EVENT_JDHBI")
    public static class domStorageItemsCleared
        extends BrowserEvent<domStorageItemsCleared>
        implements java.io.Serializable
    {
        /** <EMBED CLASS='external-html' DATA-FILE-ID=SVUID> */
        protected static final long serialVersionUID = 1;

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

        /** <CODE>[No Description Provided by Google]</CODE> */
        public final DOMStorage.StorageId storageId;

        /** Constructor.  Please review this class' fields for documentation. */
        public domStorageItemsCleared(ReadOnlyList<Boolean> isPresent, StorageId storageId)
        {
            super(singleton, Domains.DOMStorage, "domStorageItemsCleared", 1);

            this.storageId = storageId;

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

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

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




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


    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param storageId -
     * 
     * @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(StorageId storageId)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get
            (CDPTypes.CDP_TYPE, "storageId", false, "DOMStorage.clear", storageId);

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

    /**
     * Disables storage tracking, prevents storage events from being sent 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\":\"DOMStorage.disable\"}";

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

    /**
     * Enables storage tracking, storage events will now be delivered 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> enable()
    {
        // Ultra-Simple Request JSON - Because this method has no parameters
        final String requestJSON = "{\"method\":\"DOMStorage.enable\"}";

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

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param storageId -
     * 
     * @return An instance of <CODE>{@link Script}&lt;String[]&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;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
     * be retrieved.</I>
     *
     * <BR /><BR /><DIV CLASS=JDHint>
     * This Browser Function's {@code Promise} returns:
     * <CODE>String[] (<B>entries</B>)</CODE>
     * </DIV>
     */
    public static Script<String[]> getDOMStorageItems(StorageId storageId)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get
            (CDPTypes.CDP_TYPE, "storageId", false, "DOMStorage.getDOMStorageItems", storageId);

        return new Script<>(
            Domains.DOMStorage, "getDOMStorageItems", requestJSON,
            DOMStorage$$Commands::getDOMStorageItems,
            String[].class
        );
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param storageId -
     * 
     * @param key -
     * 
     * @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> removeDOMStorageItem(StorageId storageId, String key)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            DOMStorage$$Commands.removeDOMStorageItem$$, "DOMStorage.removeDOMStorageItem",
            storageId, key
        );

        return Script.NO_RET(Domains.DOMStorage, "removeDOMStorageItem", requestJSON);
    }

    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param storageId -
     * 
     * @param key -
     * 
     * @param value -
     * 
     * @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> setDOMStorageItem(StorageId storageId, String key, String value)
    {
        // Convert all Method Parameters into a JSON Request-Object (as a String)
        final String requestJSON = WriteJSON.get(
            DOMStorage$$Commands.setDOMStorageItem$$, "DOMStorage.setDOMStorageItem",
            storageId, key, value
        );

        return Script.NO_RET(Domains.DOMStorage, "setDOMStorageItem", requestJSON);
    }


}