Package Torello.Browser.BrowserAPI

Class HeadlessExperimental.beginFrame$$RET

java.lang.Object

Torello.Browser.BaseType<HeadlessExperimental.beginFrame$$RET>

Torello.Browser.BrowserAPI.HeadlessExperimental.beginFrame$$RET

All Implemented Interfaces:

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

Enclosing class:

HeadlessExperimental

public static class HeadlessExperimental.beginFrame$$RET
extends BaseType<HeadlessExperimental.beginFrame$$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 beginFrame. This command is defined in the HeadlessExperimental 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.

Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a screenshot from the resulting frame. Requires that the target was created with enabled BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also https://goo.gle/chrome-headless-rendering for more background.

See Also:

HeadlessExperimental.beginFrame(java.lang.Number, java.lang.Number, java.lang.Boolean, Torello.Browser.BrowserAPI.HeadlessExperimental.ScreenshotParams), Serialized Form

Hi-Lited Source-Code:

This File's Source Code:

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

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

• View Here: HeadlessExperimental$$beginFrame$$RET.java
• Open New Browser-Tab: HeadlessExperimental$$beginFrame$$RET.java

File Size: 8,096 Bytes Line Count: 192 '\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
boolean	hasDamage	Whether the BeginFrame resulted in damage and, thus, a new frame was committed to the display.
String	screenshotData	Base64-encoded image data of the screenshot, if one was requested and successfully taken.

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
beginFrame$$RET(ReadOnlyList<Boolean> isPresent, boolean hasDamage, String screenshotData)	Constructor.

Method Summary

Static Builder Convert a JsonObject to a POJO
Modifier and Type	Method	Description
static HeadlessExperimental.beginFrame$$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<HeadlessExperimental.beginFrame$$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

hasDamage

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final boolean hasDamage

Whether the BeginFrame resulted in damage and, thus, a new frame was committed to the display. Reported for diagnostic uses, may be removed in the future.

screenshotData

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String screenshotData

Base64-encoded image data of the screenshot, if one was requested and successfully taken. (Encoded as a base64 string when passed over JSON)
OPTIONAL

Constructor Detail

beginFrame$$RET

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public beginFrame$$RET(ReadOnlyList<java.lang.Boolean> isPresent,
                       boolean hasDamage,
                       java.lang.String screenshotData)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static HeadlessExperimental.beginFrame$$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<HeadlessExperimental.beginFrame$$RET> descriptor
            ()

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

Code:

Exact Method Body:

 return singleton.descriptor();