java.lang.Object
- Torello.Browser.BrowserAPI.DOMDebugger

```
public class DOMDebugger
extends java.lang.Object
```
This class was built using the Chrome Remote Dev-Tools A.P.I., which is specified by two JSON-RPC Files. These files were obtained from the Chrome Dev Tools Protocol Git Hub Page, which has a "Tip of Tree" (the latest) API-Specification Page Here: JSON-RPC Protocol Specification.

These files were converted into this Java-Browser (CDP) Library. The intention is to have them function in a similar fasion to the Node.js Tool known as 'Puppeteer', Microsoft's 'Playwright' and of course the Main-Stay 'Selenium.' The Java-HTML JAR Library merely implements the Java Types & Commands defined by Google's DevTools Protocol.

🧠 View the Google CDP API:
- browser_protocol.json
- js_protocol.json
- Browser API HTML-Page
- Java-Script API HTML-Page
DOM debugging allows setting breakpoints on particular DOM operations and events. JavaScript execution will stop on these operations as if there was a regular breakpoint set.

The top-level description and explanation for this class (this comment, at the top this Java-Doc Page) is repeated, verbatim, across all of the domain classes which comprise Google's CDP API.
This class is intended to be used with a Browser Instance
These methods have been tested, to some degree, using Google Chrome. In order to use this class you must start a web-browser instance and make a connection to the browser using a Remote Debugging Port. Google-Corporation is the developer of this API, but any browser which accepts a Remote Debug Port Connection over Web-Sockets.

Google-Chrome was used during the development process of the classes in this particular package. Lately, it has been asserted Microsoft has switched to using the Chrome Browser-Engine for its Microsoft Edge Internal Code-Base. Therefore, there may some functionality available when running the methods in this class with Microsoft-Edge.

Check whether the your Web-Browser will allow itself to be driven by the Web-Socket RDP-Port 9223. See the examples available in package Torello.Browser to undertand how to build a PageConn and BrowserConn Web-Socket Connection, and how to build a WebSocketSender instance in order to execute the methods in this class.

Web-Socket & JSON API:
Every one of the methods that reside in this class are designed to do nothing more than:
1. Accept Parameters from the User, and "Marshall Them" into a Valid JSON-Request
2. Transmit the Marshalled Request-JSON to a Headless Web-Browser over a Web-Socket Connection
3. Receive BOTH that Command-Results AND any Browser Event-Firings from the Web-Socket
4. Parse JSON Method-Results and Browser-Event Firings, and Subsequently Convert them to Standard Java-Types
5. Report these Method-Results and Browser-Events to the User via a User-Registered, Event-Listener (Events) or a Promise Object (Command Responses / Results)
Unlike the bulk of the Java HTML JAR Library, there is very little native Java-Code, and very little testing that may be done on any of the classes & methods in this package. The code inside these classes does nothing more than marshall-and-unmarshall Java-Types into Json-Requests (and vice-versa). The Java-Script & Browser modules inside of a Google-Chrome instance are, theoretically, handling these requests, and returning their results (or events) over the Web-Socket Connection.

It has been asserted (by Google Chrome Developers) that some of these methods are only "partially working" or "experimental".

Asking Chat-GPT for Help:
The LLM otherwise known as "Chat-GPT" does, indeed, have an expert level of knowledge about the "Remote DevTools Protocol". The API that the Chrome DevTools Protocl (CDP) exports is extremely well understood by the LLM, and generally I have found that Chat-GPT understands (by 2 or 3 orders of magnitude) better what my Auto-Generated JSON-Wrappers can do in controlling a Web-Browser than I could ever possibly hope to understand.

Though not available today, there will soon be an automatically downloadable Token-Stream (AI Embeddings) BUTTON available on my Java-Doc Pages that should hopefully make it extremely easy to post my code-base, RAG Style, to Chat-GPT and other LLM's when 'interogating' them. Presently, because my "Get Token Stream Button" does not exist yet on any of my pages, what you can do is copy-and-paste any Method-Signature from any one of these pages and then ask Chat-GPT to explain what that Browser or Java-Script Function is actually doing. It is very likely to give you some pretty neat answers.

I have found that every single one of the Domains, Types & Events which are offered by the CDP Protocol (though not documented very well by Google), are perfectly understood by the A.I. LLM - literally to the point where it does know (much better than I ever could) what my own code base actually does!

Try it out, it's a lot of fun. Note that this package and these classes were originally developed solely to be able to execute the Java-Script that a browser executes when visiting a Web-Site. Complete HTML-Page Content can be scraped (using the HTML Data-Scraping Tools in Java-HTML) off of Web-Sites that have dynamic / Java-Script Generated Content.

Conspicuous Boxed-Types Usage:
You may notice that there are many methods that have parameters which accept, for instance, an Integer, instead of a primitive int. Just to remind the readiner, in Java Programs a Boxed Type is a standard Java-Primitive which has been converted into an Object-Reference. The use of Boxed-Types in this code base is an easy-and-fast-way to allow for the concept of "Optional Parameters" or "Optional Field Value."

Whenever you see a method that accepts an Integer, the reason for this Parameter-Type choice is actually to allow a user to pass 'null' to it. This is a simple way to ELIDE passing any value at all to parameters which Google-Chrome would otherwise assert are "Optional." Whenever you pass 'null' to a Boxed-Types in this class, the Json-Processor will simply eliminate that Object-Property from the command altogether; and the browser will simply not receive any value for that parameter when that command is invoked.

The Java Language Specification does not have an easy or well defined means of accepting optional method parameters; so Boxed-Types and 'null' are utilized here. Note that 'null' may be passed to any Command Method-Parameter that is listed as Optional on the Java-Doc Page description for that parameter.
Hi-Lited Source-Code:
This File's Source Code:
- View Here: Torello/Browser/BrowserAPI/DOMDebugger.java
- Open New Browser-Tab: Torello/Browser/BrowserAPI/DOMDebugger.java
File Size: 19,411 Bytes Line Count: 481 '\n' Characters Found
Helper: Command Invocation Helpers
- View Here: DOMDebugger$$Commands.java
- Open New Browser-Tab: DOMDebugger$$Commands.java
File Size: 4,361 Bytes Line Count: 99 '\n' Characters Found
Stateless Class:
This class neither contains any program-state, nor can it be instantiated. The @StaticFunctional Annotation may also be called 'The Spaghetti Report'. Static-Functional classes are, essentially, C-Styled Files, without any constructors or non-static member fields. It is a concept very similar to the Java-Bean's @Stateless Annotation.
- 1 Constructor(s), 1 declared private, zero-argument constructor
- 10 Method(s), 10 declared static
- 2 Field(s), 2 declared static, 2 declared final

Nested Class Summary

Type Nested Classes: Types / Classes that Are Used & Exported by this Domain

Modifier and Type Class Description

static class DOMDebugger.EventListener
Object event listener.

Field Summary

Enumerated Strings: Like Java 'enum' Types, but Converted to Read-Only String-Lists

Modifier and Type	Field	Description
`static ReadOnlyList<String>`	`CSPViolationType`	CSP Violation type.
`static ReadOnlyList<String>`	`DOMBreakpointType`	DOM breakpoint type.

Method Summary

DOMDebugger Domain Commands

Script Returns	Modifier and Type	Method
`DOMDebugger.EventListener[]`	`static Script<>`	`getEventListeners(String objectId, Integer depth, Boolean pierce)` Returns event listeners of the given object.
`Void`	`static Script<>`	`removeDOMBreakpoint(int nodeId, String type)` Removes DOM breakpoint that was set using `setDOMBreakpoint`.
`Void`	`static Script<>`	`removeEventListenerBreakpoint(String eventName, String targetName)` Removes breakpoint on particular DOM event.
`Void`	`static Script<>`	`removeInstrumentationBreakpoint(String eventName)` Removes breakpoint on particular native event.
`Void`	`static Script<>`	`removeXHRBreakpoint(String url)` Removes breakpoint from XMLHttpRequest.
`Void`	`static Script<>`	`setBreakOnCSPViolation(String[] violationTypes)` Sets breakpoint on particular CSP violations.
`Void`	`static Script<>`	`setDOMBreakpoint(int nodeId, String type)` Sets breakpoint on particular operation with DOM.
`Void`	`static Script<>`	`setEventListenerBreakpoint(String eventName, String targetName)` Sets breakpoint on particular DOM event.
`Void`	`static Script<>`	`setInstrumentationBreakpoint(String eventName)` Sets breakpoint on particular native event.
`Void`	`static Script<>`	`setXHRBreakpoint(String url)` Sets breakpoint on XMLHttpRequest.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CSPViolationType
    
    🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static final ReadOnlyList<java.lang.String> CSPViolationType
    
    CSP Violation type.
    EXPERIMENTAL
    
    String-Enumeration Type
  - DOMBreakpointType
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static final ReadOnlyList<java.lang.String> DOMBreakpointType
    
    DOM breakpoint type.
    
    String-Enumeration Type
- Method Detail
  - getEventListeners
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<DOMDebugger.EventListener[]> getEventListeners (java.lang.String objectId, java.lang.Integer depth, java.lang.Boolean pierce)
    
    Returns event listeners of the given object.
    
    Parameters:
    
    objectId - Identifier of the object to return listeners for.
    
    depth - The maximum depth at which Node children should be retrieved, defaults to 1. Use -1 for the entire subtree or provide an integer larger than 0.
    OPTIONAL
    
    pierce - Whether or not iframes and shadow roots should be traversed when returning the subtree (default is false). Reports listeners for all contexts if pierce is enabled.
    OPTIONAL
    
    Returns:
    
    An instance of Script<DOMDebugger.EventListener[]>
    
    This script may be executed, using Script.exec, and afterwards, a Promise <DOMDebugger.EventListener[]> will be returned
    
    Finally, the Promise may be awaited, using Promise.await(), and the returned result of this Browser Function may be retrieved.
    
    This Browser Function's Promise returns: DOMDebugger.EventListener[] (listeners)
    Array of relevant listeners.
  - removeDOMBreakpoint
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.Void> removeDOMBreakpoint (int nodeId, java.lang.String type)
    
    Removes DOM breakpoint that was set using setDOMBreakpoint.
    
    Parameters:
    
    nodeId - Identifier of the node to remove breakpoint from.
    
    type - Type of the breakpoint to remove.
    
    Returns:
    
    An instance of Script<Void>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<Void> to ensure that the Browser Function has run to completion.
  - removeEventListenerBreakpoint
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.Void> removeEventListenerBreakpoint (java.lang.String eventName, java.lang.String targetName)
    
    Removes breakpoint on particular DOM event.
    
    Parameters:
    
    eventName - Event name.
    
    targetName - EventTarget interface name.
    OPTIONALEXPERIMENTAL
    
    Returns:
    
    An instance of Script<Void>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<Void> to ensure that the Browser Function has run to completion.
  - removeInstrumentationBreakpoint
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.Void> removeInstrumentationBreakpoint (java.lang.String eventName)
    
    Removes breakpoint on particular native event.
    EXPERIMENTALDEPRECATED
    
    Parameters:
    
    eventName - Instrumentation name to stop on.
    
    Returns:
    
    An instance of Script<Void>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<Void> to ensure that the Browser Function has run to completion.
  - removeXHRBreakpoint
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.Void> removeXHRBreakpoint (java.lang.String url)
    
    Removes breakpoint from XMLHttpRequest.
    
    Parameters:
    
    url - Resource URL substring.
    
    Returns:
    
    An instance of Script<Void>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<Void> to ensure that the Browser Function has run to completion.
  - setBreakOnCSPViolation
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.Void> setBreakOnCSPViolation (java.lang.String[] violationTypes)
    
    Sets breakpoint on particular CSP violations.
    EXPERIMENTAL
    
    Parameters:
    
    violationTypes - CSP Violations to stop upon.
    
    Returns:
    
    An instance of Script<Void>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<Void> to ensure that the Browser Function has run to completion.
  - setDOMBreakpoint
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.Void> setDOMBreakpoint (int nodeId, java.lang.String type)
    
    Sets breakpoint on particular operation with DOM.
    
    Parameters:
    
    nodeId - Identifier of the node to set breakpoint on.
    
    type - Type of the operation to stop upon.
    
    Returns:
    
    An instance of Script<Void>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<Void> to ensure that the Browser Function has run to completion.
  - setEventListenerBreakpoint
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.Void> setEventListenerBreakpoint (java.lang.String eventName, java.lang.String targetName)
    
    Sets breakpoint on particular DOM event.
    
    Parameters:
    
    eventName - DOM Event name to stop on (any DOM event will do).
    
    targetName - EventTarget interface name to stop on. If equal to "*" or not provided, will stop on any EventTarget.
    OPTIONALEXPERIMENTAL
    
    Returns:
    
    An instance of Script<Void>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<Void> to ensure that the Browser Function has run to completion.
  - setInstrumentationBreakpoint
    
    🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.Void> setInstrumentationBreakpoint (java.lang.String eventName)
    
    Sets breakpoint on particular native event.
    EXPERIMENTALDEPRECATED
    
    Parameters:
    
    eventName - Instrumentation name to stop on.
    
    Returns:
    
    An instance of Script<Void>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<Void> to ensure that the Browser Function has run to completion.
  - setXHRBreakpoint
    
    🡅 ⇈ ⮫ 🗕 🗗 🗖
    public static Script<java.lang.Void> setXHRBreakpoint (java.lang.String url)
    
    Sets breakpoint on XMLHttpRequest.
    
    Parameters:
    
    url - Resource URL substring. All XHRs having this substring in the URL will get stopped upon.
    
    Returns:
    
    An instance of Script<Void>
    
    This Script instance must be executed before the browser receives the invocation-request.
    
    This Browser-Function does not have a return-value. You may choose to await the Promise<Void> to ensure that the Browser Function has run to completion.

Type Nested Classes: Types / Classes that Are Used & Exported by this Domain

Modifier and Type	Class	Description
`static class`	`DOMDebugger.EventListener`	Object event listener.

Fields
ReadOnlyList	CSPViolationType
ReadOnlyList	DOMBreakpointType
Methods
Script	getEventListeners(String objectId, Integer depth, Boolean pierce)
Script	removeDOMBreakpoint(int nodeId, String type)
Script	removeEventListenerBreakpoint(String eventName, String targetName)
Script	removeInstrumentationBreakpoint(String eventName)
Script	removeXHRBreakpoint(String url)
Script	setBreakOnCSPViolation(String[] violationTypes)
Script	setDOMBreakpoint(int nodeId, String type)
Script	setEventListenerBreakpoint(String eventName, String targetName)
Script	setInstrumentationBreakpoint(String eventName)
Script	setXHRBreakpoint(String url)

Class DOMDebugger

This class is intended to be used with a Browser Instance

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CSPViolationType

DOMBreakpointType

Method Detail

getEventListeners

removeDOMBreakpoint

removeEventListenerBreakpoint

removeInstrumentationBreakpoint

removeXHRBreakpoint

setBreakOnCSPViolation

setDOMBreakpoint

setEventListenerBreakpoint

setInstrumentationBreakpoint

setXHRBreakpoint