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



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


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

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

        /** Storage key */
        public final String storageKey;

        /**
         * Bucket name. Not passing a <CODE>bucketName</CODE> will retrieve the default Bucket. (https://developer.mozilla.org/en-US/docs/Web/API/Storage_API#storage_buckets)
         * <BR /><B CLASS=Opt-Top>OPTIONAL</B>
         */
        public final String bucketName;

        /** Path to the directory using each path component as an array item. */
        public final String[] pathComponents;

        /** Constructor.  Please review this class' fields for documentation. */
        public BucketFileSystemLocator(
                ReadOnlyList<Boolean> isPresent, String storageKey, String bucketName,
                String[] pathComponents
            )
        {
            super(singleton, Domains.FileSystem, "BucketFileSystemLocator", 3);

            this.storageKey     = storageKey;
            this.bucketName     = bucketName;
            this.pathComponents = pathComponents;

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

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

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

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

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

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

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

        /** Files that are directly nested under this directory. */
        public final FileSystem.File[] nestedFiles;

        /** Constructor.  Please review this class' fields for documentation. */
        public Directory(
                ReadOnlyList<Boolean> isPresent, String name, String[] nestedDirectories,
                File[] nestedFiles
            )
        {
            super(singleton, Domains.FileSystem, "Directory", 3);

            this.name               = name;
            this.nestedDirectories  = nestedDirectories;
            this.nestedFiles        = nestedFiles;

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

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

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

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

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

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

        /** Timestamp */
        public final Number lastModified;

        /** Size in bytes */
        public final Number size;

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

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

            this.name           = name;
            this.lastModified   = lastModified;
            this.size           = size;
            this.type           = type;

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

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

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




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


    /**
     * <CODE>[No Description Provided by Google]</CODE>
     * 
     * @param bucketFileSystemLocator -
     * 
     * @return An instance of <CODE>{@link Script}&lt;{@link FileSystem.Directory}&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 FileSystem.Directory}&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 FileSystem.Directory} (<B>directory</B>)</CODE>
     * <BR />
     * Returns the directory object at the path.
     * </DIV>
     */
    public static Script<FileSystem.Directory> getDirectory
        (BucketFileSystemLocator bucketFileSystemLocator)
    {
        // Build the JSON Request-Object (as a String); only 1 Parameter is passed
        final String requestJSON = WriteJSON.get(
            CDPTypes.CDP_TYPE, "bucketFileSystemLocator", false, "FileSystem.getDirectory",
            bucketFileSystemLocator
        );

        return new Script<>(
            Domains.FileSystem, "getDirectory", requestJSON,
            FileSystem$$Commands::getDirectory,
            FileSystem.Directory.class
        );
    }


}