Package Torello.Browser.BrowserAPI

Class DOMSnapshot.getSnapshot$$RET

java.lang.Object

Torello.Browser.BaseType<DOMSnapshot.getSnapshot$$RET>

Torello.Browser.BrowserAPI.DOMSnapshot.getSnapshot$$RET

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BaseType<?>>

Enclosing class:

DOMSnapshot

public static class DOMSnapshot.getSnapshot$$RET
extends BaseType<DOMSnapshot.getSnapshot$$RET>
implements java.io.Serializable

This Nested Java Class was written in order to incorporate the litany of all return-values from the browser command getSnapshot. This command is defined in the DOMSnapshot domain, which is located in the BrowserAPI.

📌 All browser commands having a dedicated return type nested class will have a name which begins with a lower case letter, and ends with the string '$$RET'.

⚠️ Browser return types are only created for commands in which 2 or more values are returned by a CDP command.

Returns a document snapshot, including the full DOM tree of the root node (including iframes, template contents, and imported documents) in a flattened array, as well as layout and white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is flattened.
DEPRECATED

See Also:

DOMSnapshot.getSnapshot(java.lang.String[], java.lang.Boolean, java.lang.Boolean, java.lang.Boolean), Serialized Form

Hi-Lited Source-Code:

This File's Source Code:

• View Here: Torello/Browser/BrowserAPI/DOMSnapshot.java
• Open New Browser-Tab: Torello/Browser/BrowserAPI/DOMSnapshot.java

File Size: 2,560 Bytes Line Count: 56 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc

• View Here: DOMSnapshot$$getSnapshot$$RET.java
• Open New Browser-Tab: DOMSnapshot$$getSnapshot$$RET.java

File Size: 10,488 Bytes Line Count: 250 '\n' Characters Found

Field Summary

Serializable ID
Modifier and Type	Field	Description
protected static long	serialVersionUID
Type Fields / Properties (from Google & Browser Specs)
Modifier and Type	Field	Description
DOMSnapshot.ComputedStyle[]	computedStyles	Whitelisted ComputedStyle properties for each node in the layout tree.
DOMSnapshot.DOMNode[]	domNodes	The nodes in the DOM tree.
DOMSnapshot.LayoutTreeNode[]	layoutTreeNodes	The nodes in the layout tree.

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
getSnapshot$$RET(ReadOnlyList<Boolean> isPresent, DOMSnapshot.DOMNode[] domNodes, DOMSnapshot.LayoutTreeNode[] layoutTreeNodes, DOMSnapshot.ComputedStyle[] computedStyles)	Constructor.

Method Summary

Static Builder Convert a JsonObject to a POJO
Modifier and Type	Method	Description
static DOMSnapshot.getSnapshot$$RET	fromJSON(JsonObject jo)	Creates an instance of this class from a JsonObject.
Retrieve the Type-Descriptor Singleton-Instance for this Nested Class.
Modifier and Type	Method	Description
static NestedDescriptor<DOMSnapshot.getSnapshot$$RET>	descriptor()	Returns this class's NestedDescriptor singleton-instance.

Methods inherited from class Torello.Browser.BaseType

allEnumStrROLs, compareTo, enumStrList, enumStrValidate, enumStrValidateThrow, equals, hashCode, isPresent, optionalsValidate, optionalsValidateThrow, toJSON, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

🡇 ⇈ ⮫ 🗕 🗗 🗖

protected static final long serialVersionUID

This fulfils the SerialVersion UID requirement for all classes that implement Java's interface java.io.Serializable. Using the Serializable Implementation offered by java is very easy, and can make saving program state when debugging a lot easier. It can also be used in place of more complicated systems like "hibernate" to store data as well.

See Also:

Constant Field Values

domNodes

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOMSnapshot.DOMNode[] domNodes

The nodes in the DOM tree. The DOMNode at index 0 corresponds to the root document.

layoutTreeNodes

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOMSnapshot.LayoutTreeNode[] layoutTreeNodes

The nodes in the layout tree.

computedStyles

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final DOMSnapshot.ComputedStyle[] computedStyles

Whitelisted ComputedStyle properties for each node in the layout tree.

Constructor Detail

getSnapshot$$RET

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public getSnapshot$$RET(ReadOnlyList<java.lang.Boolean> isPresent,
                        DOMSnapshot.DOMNode[] domNodes,
                        DOMSnapshot.LayoutTreeNode[] layoutTreeNodes,
                        DOMSnapshot.ComputedStyle[] computedStyles)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static DOMSnapshot.getSnapshot$$RET fromJSON(JsonObject jo)

Creates an instance of this class from a JsonObject.

Code:

Exact Method Body:

 return singleton.fromJSON(jo);

descriptor

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static NestedDescriptor<DOMSnapshot.getSnapshot$$RET> descriptor()

Returns this class's NestedDescriptor singleton-instance. class / type.

Code:

Exact Method Body:

 return singleton.descriptor();