package Torello.Browser;

import java.util.*;
import javax.json.*;
import javax.json.stream.*;
import java.io.*;

import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
import java.util.function.Function;

import Torello.Java.Additional.*;

import static Torello.Java.Additional.JFlag.*;

import Torello.Java.StrCmpr;
import Torello.JavaDoc.StaticFunctional;
import Torello.JavaDoc.JDHeaderBackgroundImg;
import Torello.JavaDoc.Excuse;

/**
 * <SPAN CLASS=CopiedJDK><B><CODE>[No Description Provided by Google]</CODE></B></SPAN>
 * 
 * <EMBED CLASS='external-html' DATA-FILE-ID=CODE_GEN_NOTE>
 */
@StaticFunctional(Excused={"counter"}, Excuses={Excuse.CONFIGURATION})
@JDHeaderBackgroundImg(EmbedTagFileID="WOOD_PLANK_NOTE")
public class Accessibility
{
    // ********************************************************************************************
    // ********************************************************************************************
    // Class Header Stuff
    // ********************************************************************************************
    // ********************************************************************************************


    // No Pubic Constructors
    private Accessibility () { }

    // These two Vector's are used by all the "Methods" exported by this class.  java.lang.reflect
    // is used to generate the JSON String's.  It saves thousands of lines of Auto-Generated Code.
    private static final Map<String, Vector<String>>    parameterNames = new HashMap<>();
    private static final Map<String, Vector<Class<?>>>  parameterTypes = new HashMap<>();

    // Some Methods do not take any parameters - for instance all the "enable()" and "disable()"
    // I simply could not get ride of RAW-TYPES and UNCHECKED warnings... so there are now,
    // offically, two empty-vectors.  One for String's, and the other for Classes.

    private static final Vector<String>     EMPTY_VEC_STR = new Vector<>();
    private static final Vector<Class<?>>   EMPTY_VEC_CLASS = new Vector<>();

    static
    {
        for (Method m : Accessibility.class.getMethods())
        {
            // This doesn't work!  The parameter names are all "arg0" ... "argN"
            // It works for java.lang.reflect.Field, BUT NOT java.lang.reflect.Parameter!
            //
            // Vector<String> parameterNamesList = new Vector<>(); -- NOPE!

            Vector<Class<?>> parameterTypesList = new Vector<>();
        
            for (Parameter p : m.getParameters()) parameterTypesList.add(p.getType());

            parameterTypes.put(
                m.getName(),
                (parameterTypesList.size() > 0) ? parameterTypesList : EMPTY_VEC_CLASS
            );
        }
    }

    static
    {
        Vector<String> v = null;

        parameterNames.put("disable", EMPTY_VEC_STR);

        parameterNames.put("enable", EMPTY_VEC_STR);

        v = new Vector<String>(4);
        parameterNames.put("getPartialAXTree", v);
        Collections.addAll(v, new String[]
        { "nodeId", "backendNodeId", "objectId", "fetchRelatives", });

        v = new Vector<String>(3);
        parameterNames.put("getFullAXTree", v);
        Collections.addAll(v, new String[]
        { "depth", "max_depth", "frameId", });

        v = new Vector<String>(2);
        parameterNames.put("getChildAXNodes", v);
        Collections.addAll(v, new String[]
        { "id", "frameId", });

        v = new Vector<String>(5);
        parameterNames.put("queryAXTree", v);
        Collections.addAll(v, new String[]
        { "nodeId", "backendNodeId", "objectId", "accessibleName", "role", });
    }


    // ********************************************************************************************
    // ********************************************************************************************
    // Types - Static Inner Classes
    // ********************************************************************************************
    // ********************************************************************************************

    // public static class AXNodeId => String
    
    /** Enum of possible property types. */
    public static final String[] AXValueType =
    { 
        "boolean", "tristate", "booleanOrUndefined", "idref", "idrefList", "integer", "node", 
        "nodeList", "number", "string", "computedString", "token", "tokenList", "domRelation", 
        "role", "internalRole", "valueUndefined", 
    };
    
    /** Enum of possible property sources. */
    public static final String[] AXValueSourceType =
    { "attribute", "implicit", "style", "contents", "placeholder", "relatedElement", };
    
    /** Enum of possible native property sources (as a subtype of a particular AXValueSourceType). */
    public static final String[] AXValueNativeSourceType =
    { 
        "description", "figcaption", "label", "labelfor", "labelwrapped", "legend", 
        "rubyannotation", "tablecaption", "title", "other", 
    };
    
    /**
     * Values of AXProperty name:
     * - from 'busy' to 'roledescription': states which apply to every AX node
     * - from 'live' to 'root': attributes which apply to nodes in live regions
     * - from 'autocomplete' to 'valuetext': attributes which apply to widgets
     * - from 'checked' to 'selected': states which apply to widgets
     * - from 'activedescendant' to 'owns' - relationships between elements other than parent/child/sibling.
     */
    public static final String[] AXPropertyName =
    { 
        "busy", "disabled", "editable", "focusable", "focused", "hidden", "hiddenRoot", "invalid", 
        "keyshortcuts", "settable", "roledescription", "live", "atomic", "relevant", "root", 
        "autocomplete", "hasPopup", "level", "multiselectable", "orientation", "multiline", 
        "readonly", "required", "valuemin", "valuemax", "valuetext", "checked", "expanded", 
        "modal", "pressed", "selected", "activedescendant", "controls", "describedby", "details", 
        "errormessage", "flowto", "labelledby", "owns", 
    };
    
    /** A single source for a computed AX property. */
    public static class AXValueSource extends BaseType
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, true, true, true, true, true, true, true, true, }; }
        
        /** What type of source this is. */
        public final String type;
        
        /**
         * The value of this property source.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Accessibility.AXValue value;
        
        /**
         * The name of the relevant attribute, if any.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String attribute;
        
        /**
         * The value of the relevant attribute, if any.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Accessibility.AXValue attributeValue;
        
        /**
         * Whether this source is superseded by a higher priority source.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Boolean superseded;
        
        /**
         * The native markup source for this value, e.g. a &lt;label&gt; element.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String nativeSource;
        
        /**
         * The value, such as a node or node list, of the native source.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Accessibility.AXValue nativeSourceValue;
        
        /**
         * Whether the value for this property is invalid.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Boolean invalid;
        
        /**
         * Reason for the value being invalid, if it is.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String invalidReason;
        
        /**
         * Constructor
         *
         * @param type What type of source this is.
         * 
         * @param value The value of this property source.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param attribute The name of the relevant attribute, if any.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param attributeValue The value of the relevant attribute, if any.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param superseded Whether this source is superseded by a higher priority source.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param nativeSource The native markup source for this value, e.g. a &lt;label&gt; element.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param nativeSourceValue The value, such as a node or node list, of the native source.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param invalid Whether the value for this property is invalid.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param invalidReason Reason for the value being invalid, if it is.
         * <BR /><B>OPTIONAL</B>
         */
        public AXValueSource(
                String type, Accessibility.AXValue value, String attribute, 
                Accessibility.AXValue attributeValue, Boolean superseded, String nativeSource, 
                Accessibility.AXValue nativeSourceValue, Boolean invalid, String invalidReason
            )
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (type == null) BRDPC.throwNPE("type");
            
            // Exception-Check(s) to ensure that if any parameters which must adhere to a
            // provided List of Enumerated Values, fails, then IllegalArgumentException shall throw.
            
            BRDPC.checkIAE("type", type, "Accessibility.AXValueSourceType", Accessibility.AXValueSourceType);
            BRDPC.checkIAE("nativeSource", nativeSource, "Accessibility.AXValueNativeSourceType", Accessibility.AXValueNativeSourceType);
            
            this.type               = type;
            this.value              = value;
            this.attribute          = attribute;
            this.attributeValue     = attributeValue;
            this.superseded         = superseded;
            this.nativeSource       = nativeSource;
            this.nativeSourceValue  = nativeSourceValue;
            this.invalid            = invalid;
            this.invalidReason      = invalidReason;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'AXValueSource'}.
         */
        public AXValueSource (JsonObject jo)
        {
            this.type               = ReadJSON.getString(jo, "type", false, true);
            this.value              = ReadJSON.XL.getObject(jo, "value", Accessibility.AXValue.class, true, false);
            this.attribute          = ReadJSON.getString(jo, "attribute", true, false);
            this.attributeValue     = ReadJSON.XL.getObject(jo, "attributeValue", Accessibility.AXValue.class, true, false);
            this.superseded         = ReadJSON.getBOOLEAN(jo, "superseded", true);
            this.nativeSource       = ReadJSON.getString(jo, "nativeSource", true, false);
            this.nativeSourceValue  = ReadJSON.XL.getObject(jo, "nativeSourceValue", Accessibility.AXValue.class, true, false);
            this.invalid            = ReadJSON.getBOOLEAN(jo, "invalid", true);
            this.invalidReason      = ReadJSON.getString(jo, "invalidReason", true, false);
        }
        
    }
    
    /** <CODE>[No Description Provided by Google]</CODE> */
    public static class AXRelatedNode extends BaseType
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, true, true, }; }
        
        /** The BackendNodeId of the related DOM node. */
        public final int backendDOMNodeId;
        
        /**
         * The IDRef value provided, if any.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String idref;
        
        /**
         * The text alternative of this node in the current context.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String text;
        
        /**
         * Constructor
         *
         * @param backendDOMNodeId The BackendNodeId of the related DOM node.
         * 
         * @param idref The IDRef value provided, if any.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param text The text alternative of this node in the current context.
         * <BR /><B>OPTIONAL</B>
         */
        public AXRelatedNode(int backendDOMNodeId, String idref, String text)
        {
            this.backendDOMNodeId  = backendDOMNodeId;
            this.idref             = idref;
            this.text              = text;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'AXRelatedNode'}.
         */
        public AXRelatedNode (JsonObject jo)
        {
            this.backendDOMNodeId  = ReadJSON.getInt(jo, "backendDOMNodeId");
            this.idref             = ReadJSON.getString(jo, "idref", true, false);
            this.text              = ReadJSON.getString(jo, "text", true, false);
        }
        
    }
    
    /** <CODE>[No Description Provided by Google]</CODE> */
    public static class AXProperty extends BaseType
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, }; }
        
        /** The name of this property. */
        public final String name;
        
        /** The value of this property. */
        public final Accessibility.AXValue value;
        
        /**
         * Constructor
         *
         * @param name The name of this property.
         * 
         * @param value The value of this property.
         */
        public AXProperty(String name, Accessibility.AXValue value)
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (name == null)  BRDPC.throwNPE("name");
            if (value == null) BRDPC.throwNPE("value");
            
            // Exception-Check(s) to ensure that if any parameters which must adhere to a
            // provided List of Enumerated Values, fails, then IllegalArgumentException shall throw.
            
            BRDPC.checkIAE("name", name, "Accessibility.AXPropertyName", Accessibility.AXPropertyName);
            
            this.name   = name;
            this.value  = value;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'AXProperty'}.
         */
        public AXProperty (JsonObject jo)
        {
            this.name   = ReadJSON.getString(jo, "name", false, true);
            this.value  = ReadJSON.XL.getObject(jo, "value", Accessibility.AXValue.class, false, true);
        }
        
    }
    
    /** A single computed AX property. */
    public static class AXValue extends BaseType
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, true, true, true, }; }
        
        /** The type of this value. */
        public final String type;
        
        /**
         * The computed value of this property.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final JsonValue value;
        
        /**
         * One or more related nodes, if applicable.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Accessibility.AXRelatedNode[] relatedNodes;
        
        /**
         * The sources which contributed to the computation of this property.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Accessibility.AXValueSource[] sources;
        
        /**
         * Constructor
         *
         * @param type The type of this value.
         * 
         * @param value The computed value of this property.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param relatedNodes One or more related nodes, if applicable.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param sources The sources which contributed to the computation of this property.
         * <BR /><B>OPTIONAL</B>
         */
        public AXValue(
                String type, JsonValue value, Accessibility.AXRelatedNode[] relatedNodes, 
                Accessibility.AXValueSource[] sources
            )
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (type == null) BRDPC.throwNPE("type");
            
            // Exception-Check(s) to ensure that if any parameters which must adhere to a
            // provided List of Enumerated Values, fails, then IllegalArgumentException shall throw.
            
            BRDPC.checkIAE("type", type, "Accessibility.AXValueType", Accessibility.AXValueType);
            
            this.type          = type;
            this.value         = value;
            this.relatedNodes  = relatedNodes;
            this.sources       = sources;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'AXValue'}.
         */
        public AXValue (JsonObject jo)
        {
            this.type          = ReadJSON.getString(jo, "type", false, true);
            this.value         = jo.get("value");
            this.relatedNodes  = (jo.getJsonArray("relatedNodes") == null)
            ? null
            : ReadArrJSON.DimN.objArr(jo.getJsonArray("relatedNodes"), null, 0, Accessibility.AXRelatedNode[].class);
            this.sources       = (jo.getJsonArray("sources") == null)
            ? null
            : ReadArrJSON.DimN.objArr(jo.getJsonArray("sources"), null, 0, Accessibility.AXValueSource[].class);
        }
        
    }
    
    /** A node in the accessibility tree. */
    public static class AXNode extends BaseType
    {
        /** For Object Serialization.  java.io.Serializable */
        protected static final long serialVersionUID = 1;
        
        public boolean[] optionals()
        { return new boolean[] { false, false, true, true, true, true, true, true, true, true, }; }
        
        /** Unique identifier for this node. */
        public final String nodeId;
        
        /** Whether this node is ignored for accessibility */
        public final boolean ignored;
        
        /**
         * Collection of reasons why this node is hidden.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Accessibility.AXProperty[] ignoredReasons;
        
        /**
         * This <CODE>Node</CODE>'s role, whether explicit or implicit.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Accessibility.AXValue role;
        
        /**
         * The accessible name for this <CODE>Node</CODE>.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Accessibility.AXValue name;
        
        /**
         * The accessible description for this <CODE>Node</CODE>.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Accessibility.AXValue description;
        
        /**
         * The value for this <CODE>Node</CODE>.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Accessibility.AXValue value;
        
        /**
         * All other properties
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Accessibility.AXProperty[] properties;
        
        /**
         * IDs for each of this node's child nodes.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final String[] childIds;
        
        /**
         * The backend ID for the associated DOM node, if any.
         * <BR />
         * <BR /><B>OPTIONAL</B>
         */
        public final Integer backendDOMNodeId;
        
        /**
         * Constructor
         *
         * @param nodeId Unique identifier for this node.
         * 
         * @param ignored Whether this node is ignored for accessibility
         * 
         * @param ignoredReasons Collection of reasons why this node is hidden.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param role This <CODE>Node</CODE>'s role, whether explicit or implicit.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param name The accessible name for this <CODE>Node</CODE>.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param description The accessible description for this <CODE>Node</CODE>.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param value The value for this <CODE>Node</CODE>.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param properties All other properties
         * <BR /><B>OPTIONAL</B>
         * 
         * @param childIds IDs for each of this node's child nodes.
         * <BR /><B>OPTIONAL</B>
         * 
         * @param backendDOMNodeId The backend ID for the associated DOM node, if any.
         * <BR /><B>OPTIONAL</B>
         */
        public AXNode(
                String nodeId, boolean ignored, Accessibility.AXProperty[] ignoredReasons, 
                Accessibility.AXValue role, Accessibility.AXValue name, 
                Accessibility.AXValue description, Accessibility.AXValue value, 
                Accessibility.AXProperty[] properties, String[] childIds, Integer backendDOMNodeId
            )
        {
            // Exception-Check(s) to ensure that if any parameters which are not declared as
            // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
            
            if (nodeId == null) BRDPC.throwNPE("nodeId");
            
            this.nodeId            = nodeId;
            this.ignored           = ignored;
            this.ignoredReasons    = ignoredReasons;
            this.role              = role;
            this.name              = name;
            this.description       = description;
            this.value             = value;
            this.properties        = properties;
            this.childIds          = childIds;
            this.backendDOMNodeId  = backendDOMNodeId;
        }
        
        /**
         * JSON Object Constructor
         * @param jo A Json-Object having data about an instance of {@code 'AXNode'}.
         */
        public AXNode (JsonObject jo)
        {
            this.nodeId            = ReadJSON.getString(jo, "nodeId", false, true);
            this.ignored           = ReadJSON.getBoolean(jo, "ignored");
            this.ignoredReasons    = (jo.getJsonArray("ignoredReasons") == null)
            ? null
            : ReadArrJSON.DimN.objArr(jo.getJsonArray("ignoredReasons"), null, 0, Accessibility.AXProperty[].class);
            this.role              = ReadJSON.XL.getObject(jo, "role", Accessibility.AXValue.class, true, false);
            this.name              = ReadJSON.XL.getObject(jo, "name", Accessibility.AXValue.class, true, false);
            this.description       = ReadJSON.XL.getObject(jo, "description", Accessibility.AXValue.class, true, false);
            this.value             = ReadJSON.XL.getObject(jo, "value", Accessibility.AXValue.class, true, false);
            this.properties        = (jo.getJsonArray("properties") == null)
            ? null
            : ReadArrJSON.DimN.objArr(jo.getJsonArray("properties"), null, 0, Accessibility.AXProperty[].class);
            this.childIds          = (jo.getJsonArray("childIds") == null)
            ? null
            : ReadArrJSON.DimN.strArr(jo.getJsonArray("childIds"), null, 0, String[].class);
            this.backendDOMNodeId  = ReadJSON.getINTEGER(jo, "backendDOMNodeId", true);
        }
        
    }
    
    
    // Counter for keeping the WebSocket Request ID's distinct.
    private static int counter = 1;
    
    /**
     * Disables the accessibility domain.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&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 />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 <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> disable()
    {
        final int          webSocketID = 7000000 + counter++;
        final boolean[]    optionals   = new boolean[0];
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("disable"),
            parameterNames.get("disable"),
            optionals, webSocketID,
            "Accessibility.disable"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Enables the accessibility domain which causes <CODE>AXNodeId</CODE>s to remain consistent between method calls.
     * This turns on accessibility for the page, which can impact performance until accessibility is disabled.
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Ret0}&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 />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 <JsonObject,} {@link Ret0}
     * {@code >} to ensure the Browser Function has run to completion.
     */
    public static Script<String, JsonObject, Ret0> enable()
    {
        final int          webSocketID = 7001000 + counter++;
        final boolean[]    optionals   = new boolean[0];
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("enable"),
            parameterNames.get("enable"),
            optionals, webSocketID,
            "Accessibility.enable"
        );
        
        // This Remote Command does not have a Return-Value.
        return new Script<>
            (BRDPC.defaultSender, webSocketID, requestJSON, BRDPC.NoReturnValues);
    }
    
    /**
     * Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
     * <BR /><B>EXPERIMENTAL</B>
     * 
     * @param nodeId Identifier of the node to get the partial accessibility tree for.
     * <BR /><B>OPTIONAL</B>
     * 
     * @param backendNodeId Identifier of the backend node to get the partial accessibility tree for.
     * <BR /><B>OPTIONAL</B>
     * 
     * @param objectId JavaScript object id of the node wrapper to get the partial accessibility tree for.
     * <BR /><B>OPTIONAL</B>
     * 
     * @param fetchRelatives Whether to fetch this nodes ancestors, siblings and children. Defaults to true.
     * <BR /><B>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Accessibility.AXNode}[]&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * {@link Accessibility.AXNode}[]&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
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>{@link Accessibility.AXNode}[] (<B>nodes</B></CODE>)
     *     <BR />The <CODE>Accessibility.AXNode</CODE> for this DOM node, if it exists, plus its ancestors, siblings and
     *     children, if requested.
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, Accessibility.AXNode[]> getPartialAXTree
        (Integer nodeId, Integer backendNodeId, String objectId, Boolean fetchRelatives)
    {
        final int       webSocketID = 7002000 + counter++;
        final boolean[] optionals   = { true, true, true, true, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("getPartialAXTree"),
            parameterNames.get("getPartialAXTree"),
            optionals, webSocketID,
            "Accessibility.getPartialAXTree",
            nodeId, backendNodeId, objectId, fetchRelatives
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'Accessibility.AXNode[]'
        Function<JsonObject, Accessibility.AXNode[]> responseProcessor = (JsonObject jo) ->
            (jo.getJsonArray("nodes") == null)
                ? null
                : ReadArrJSON.DimN.objArr(jo.getJsonArray("nodes"), null, 0, Accessibility.AXNode[].class);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * Fetches the entire accessibility tree for the root Document
     * <BR /><B>EXPERIMENTAL</B>
     * 
     * @param depth 
     * The maximum depth at which descendants of the root node should be retrieved.
     * If omitted, the full tree is returned.
     * <BR /><B>OPTIONAL</B>
     * 
     * @param max_depth Deprecated. This parameter has been renamed to <CODE>depth</CODE>. If depth is not provided, max_depth will be used.
     * <BR /><B>OPTIONAL</B>
     * <BR /><B>DEPRECATED</B>
     * 
     * @param frameId 
     * The frame for whose document the AX tree should be retrieved.
     * If omited, the root frame is used.
     * <BR /><B>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Accessibility.AXNode}[]&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * {@link Accessibility.AXNode}[]&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
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>{@link Accessibility.AXNode}[] (<B>nodes</B></CODE>)
     *     <BR />-
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, Accessibility.AXNode[]> getFullAXTree
        (Integer depth, Integer max_depth, String frameId)
    {
        final int       webSocketID = 7003000 + counter++;
        final boolean[] optionals   = { true, true, true, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("getFullAXTree"),
            parameterNames.get("getFullAXTree"),
            optionals, webSocketID,
            "Accessibility.getFullAXTree",
            depth, max_depth, frameId
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'Accessibility.AXNode[]'
        Function<JsonObject, Accessibility.AXNode[]> responseProcessor = (JsonObject jo) ->
            (jo.getJsonArray("nodes") == null)
                ? null
                : ReadArrJSON.DimN.objArr(jo.getJsonArray("nodes"), null, 0, Accessibility.AXNode[].class);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * Fetches a particular accessibility node by AXNodeId.
     * Requires <CODE>enable()</CODE> to have been called previously.
     * <BR /><B>EXPERIMENTAL</B>
     * 
     * @param id -
     * 
     * @param frameId 
     * The frame in whose document the node resides.
     * If omitted, the root frame is used.
     * <BR /><B>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Accessibility.AXNode}[]&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * {@link Accessibility.AXNode}[]&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
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>{@link Accessibility.AXNode}[] (<B>nodes</B></CODE>)
     *     <BR />-
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, Accessibility.AXNode[]> getChildAXNodes
        (String id, String frameId)
    {
        // Exception-Check(s) to ensure that if any parameters which are not declared as
        // 'Optional', but have a 'null' value anyway, that a NullPointerException shall throw.
        
        if (id == null) BRDPC.throwNPE("id");
        
        final int       webSocketID = 7004000 + counter++;
        final boolean[] optionals   = { false, true, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("getChildAXNodes"),
            parameterNames.get("getChildAXNodes"),
            optionals, webSocketID,
            "Accessibility.getChildAXNodes",
            id, frameId
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'Accessibility.AXNode[]'
        Function<JsonObject, Accessibility.AXNode[]> responseProcessor = (JsonObject jo) ->
            (jo.getJsonArray("nodes") == null)
                ? null
                : ReadArrJSON.DimN.objArr(jo.getJsonArray("nodes"), null, 0, Accessibility.AXNode[].class);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
    /**
     * Query a DOM node's accessibility subtree for accessible name and role.
     * This command computes the name and role for all nodes in the subtree, including those that are
     * ignored for accessibility, and returns those that mactch the specified name and role. If no DOM
     * node is specified, or the DOM node does not exist, the command returns an error. If neither
     * <CODE>accessibleName</CODE> or <CODE>role</CODE> is specified, it returns all the accessibility nodes in the subtree.
     * <BR /><B>EXPERIMENTAL</B>
     * 
     * @param nodeId Identifier of the node for the root to query.
     * <BR /><B>OPTIONAL</B>
     * 
     * @param backendNodeId Identifier of the backend node for the root to query.
     * <BR /><B>OPTIONAL</B>
     * 
     * @param objectId JavaScript object id of the node wrapper for the root to query.
     * <BR /><B>OPTIONAL</B>
     * 
     * @param accessibleName Find nodes with this computed name.
     * <BR /><B>OPTIONAL</B>
     * 
     * @param role Find nodes with this computed role.
     * <BR /><B>OPTIONAL</B>
     * 
     * @return An instance of <CODE>{@link Script}&lt;String, {@link JsonObject},
     * {@link Accessibility.AXNode}[]&gt;</CODE>
     * 
     * <BR /><BR />This <B>script</B> may be <B STYLE='color: red'>executed</B>, using
     * {@link Script#exec()}, and afterwards, a {@link Promise}<CODE>&lt;JsonObject,
     * {@link Accessibility.AXNode}[]&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
      * may be retrieved.</I>
     *
     * <BR /><BR />This Browser Function <B STYLE='color: red'>returns</B>
     * <BR /><BR /><UL CLASS=JDUL>
     * <LI><CODE>{@link Accessibility.AXNode}[] (<B>nodes</B></CODE>)
     *     <BR />A list of <CODE>Accessibility.AXNode</CODE> matching the specified attributes,
     *     including nodes that are ignored for accessibility.
     * </LI>
     * </UL> */
    public static Script<String, JsonObject, Accessibility.AXNode[]> queryAXTree
        (Integer nodeId, Integer backendNodeId, String objectId, String accessibleName, String role)
    {
        final int       webSocketID = 7005000 + counter++;
        final boolean[] optionals   = { true, true, true, true, true, };
        
        // Convert Method Parameters into JSON.  Build the JSON Request-Object (as a String)
        String requestJSON = WriteJSON.get(
            parameterTypes.get("queryAXTree"),
            parameterNames.get("queryAXTree"),
            optionals, webSocketID,
            "Accessibility.queryAXTree",
            nodeId, backendNodeId, objectId, accessibleName, role
        );
        
        // 'JSON Binding' ... Converts Browser Response-JSON to 'Accessibility.AXNode[]'
        Function<JsonObject, Accessibility.AXNode[]> responseProcessor = (JsonObject jo) ->
            (jo.getJsonArray("nodes") == null)
                ? null
                : ReadArrJSON.DimN.objArr(jo.getJsonArray("nodes"), null, 0, Accessibility.AXNode[].class);
        
        // Pass the 'defaultSender' to Script-Constructor
        // The sender that is used can be changed before executing script.
        return new Script<>(BRDPC.defaultSender, webSocketID, requestJSON, responseProcessor);
    }
    
}