Package Torello.Browser.BrowserAPI

Class HeadlessExperimental.ScreenshotParams

java.lang.Object

Torello.Browser.BaseType<HeadlessExperimental.ScreenshotParams>

Torello.Browser.BrowserAPI.HeadlessExperimental.ScreenshotParams

All Implemented Interfaces:

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

Enclosing class:

HeadlessExperimental

public static class HeadlessExperimental.ScreenshotParams
extends BaseType<HeadlessExperimental.ScreenshotParams>
implements java.io.Serializable

This Nested Java Class is declared as a "Type", which is similar to a Java Class. The CDP API Specifications list this type among the types, events & commands located in the HeadlessExperimental domain, which may be found within the BrowserAPI.

📌 All browser domain type classes will have a class name that begins with an upper case letter.

Encoding options for a screenshot.

See Also:

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,507 Bytes Line Count: 62 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc

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

File Size: 9,182 Bytes Line Count: 222 '\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
String	format	Image compression format (defaults to png).
Boolean	optimizeForSpeed	Optimize image encoding for speed, not for resulting size (defaults to false)
Integer	quality	Compression quality from range [0..100] (jpeg and webp only).

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
ScreenshotParams(ReadOnlyList<Boolean> isPresent, String format, Integer quality, Boolean optimizeForSpeed)	Constructor.

Method Summary

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

format

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String format

Image compression format (defaults to png).
OPTIONAL

This particular field will have its values resricted to the contents of a CDP defined Enumerated String List. That list may be viewed inside the hilited source code from this class nested helper. Click the link below, and scroll down to find the definition for a ReadOnlyList<String> named 'format$$':

📎 HeadlessExperimental$$ScreenshotParams$$

Programmatically Accessing the Enum:

// Retrieve the list of enumerated strings for this field
ReadOnlyList<String> enumerationStrs = HeadlessExperimental.ScreenshotParams.enumStrList("format");

// Print the list of strings to the terminal
for (final String s : enumerationStrs) System.out.println('\"' + s + "\", ");

See Also:

BaseType.enumStrList(String)

quality

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Integer quality

Compression quality from range [0..100] (jpeg and webp only).
OPTIONAL

optimizeForSpeed

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Boolean optimizeForSpeed

Optimize image encoding for speed, not for resulting size (defaults to false)
OPTIONAL

Constructor Detail

ScreenshotParams

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public ScreenshotParams(ReadOnlyList<java.lang.Boolean> isPresent,
                        java.lang.String format,
                        java.lang.Integer quality,
                        java.lang.Boolean optimizeForSpeed)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static HeadlessExperimental.ScreenshotParams 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.ScreenshotParams> descriptor
            ()

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

Code:

Exact Method Body:

 return singleton.descriptor();