Package Torello.Browser.BrowserAPI

Class DOM.performSearch$$RET

java.lang.Object

Torello.Browser.BaseType<DOM.performSearch$$RET>

Torello.Browser.BrowserAPI.DOM.performSearch$$RET

All Implemented Interfaces:

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

Enclosing class:

DOM

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

Searches for a given string in the DOM tree. Use getSearchResults to access search results or cancelSearch to end this search session.
EXPERIMENTAL

See Also:

DOM.performSearch(java.lang.String, java.lang.Boolean), Serialized Form

Hi-Lited Source-Code:

This File's Source Code:

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

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

• View Here: DOM$$performSearch$$RET.java
• Open New Browser-Tab: DOM$$performSearch$$RET.java

File Size: 7,765 Bytes Line Count: 191 '\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
int	resultCount	Number of search results.
String	searchId	Unique search session identifier.

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
performSearch$$RET(ReadOnlyList<Boolean> isPresent, String searchId, int resultCount)	Constructor.

Method Summary

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

searchId

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String searchId

Unique search session identifier.

resultCount

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final int resultCount

Number of search results.

Constructor Detail

performSearch$$RET

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public performSearch$$RET(ReadOnlyList<java.lang.Boolean> isPresent,
                          java.lang.String searchId,
                          int resultCount)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

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

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

Code:

Exact Method Body:

 return singleton.descriptor();