Package Torello.Browser.BrowserAPI

Class IO.read$$RET

java.lang.Object

Torello.Browser.BaseType<IO.read$$RET>

Torello.Browser.BrowserAPI.IO.read$$RET

All Implemented Interfaces:

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

Enclosing class:

IO

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

Read a chunk of the stream

See Also:

IO.read(java.lang.String, java.lang.Integer, java.lang.Integer), Serialized Form

Hi-Lited Source-Code:

This File's Source Code:

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

File Size: 1,926 Bytes Line Count: 53 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc

• View Here: IO$$read$$RET.java
• Open New Browser-Tab: IO$$read$$RET.java

File Size: 8,002 Bytes Line Count: 201 '\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	base64Encoded	Set if the data is base64-encoded
String	data	Data that were read.
boolean	eof	Set if the end-of-file condition occurred while reading.

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
read$$RET(ReadOnlyList<Boolean> isPresent, Boolean base64Encoded, String data, boolean eof)	Constructor.

Method Summary

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

base64Encoded

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Boolean base64Encoded

Set if the data is base64-encoded
OPTIONAL

data

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String data

Data that were read.

eof

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final boolean eof

Set if the end-of-file condition occurred while reading.

Constructor Detail

read$$RET

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public read$$RET(ReadOnlyList<java.lang.Boolean> isPresent,
                 java.lang.Boolean base64Encoded,
                 java.lang.String data,
                 boolean eof)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

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

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

Code:

Exact Method Body:

 return singleton.descriptor();