Package Torello.Browser.BrowserAPI

Class Preload.RuleSet

java.lang.Object

Torello.Browser.BaseType<Preload.RuleSet>

Torello.Browser.BrowserAPI.Preload.RuleSet

All Implemented Interfaces:

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

Enclosing class:

Preload

public static class Preload.RuleSet
extends BaseType<Preload.RuleSet>
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 Preload 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.

Corresponds to SpeculationRuleSet

See Also:

Serialized Form

Hi-Lited Source-Code:

This File's Source Code:

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

File Size: 4,368 Bytes Line Count: 107 '\n' Characters Found
Helper: Equals, HashCode, toJSON, etc

• View Here: Preload$$RuleSet$$.java
• Open New Browser-Tab: Preload$$RuleSet$$.java

File Size: 11,290 Bytes Line Count: 277 '\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
Integer	backendNodeId	A speculation rule set is either added through an inline <script> tag or through an external resource via the 'Speculation-Rules' HTTP header.
String	errorMessage	TODO(https://crbug.com/1425354): Replace this property with structured error.
String	errorType	Error information errorMessage is null iff errorType is null.
String	id	[No Description Provided by Google]
String	loaderId	Identifies a document which the rule set is associated with.
String	requestId	[No Description Provided by Google]
String	sourceText	Source text of JSON representing the rule set.
String	url	[No Description Provided by Google]

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
RuleSet(ReadOnlyList<Boolean> isPresent, String id, String loaderId, String sourceText, Integer backendNodeId, String url, String requestId, String errorType, String errorMessage)	Constructor.

Method Summary

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

id

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String id

[No Description Provided by Google]

loaderId

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String loaderId

Identifies a document which the rule set is associated with.

sourceText

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String sourceText

Source text of JSON representing the rule set. If it comes from <script> tag, it is the textContent of the node. Note that it is a JSON for valid case. See also: - https://wicg.github.io/nav-speculation/speculation-rules.html - https://github.com/WICG/nav-speculation/blob/main/triggers.md

backendNodeId

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Integer backendNodeId

A speculation rule set is either added through an inline <script> tag or through an external resource via the 'Speculation-Rules' HTTP header. For the first case, we include the BackendNodeId of the relevant <script> tag. For the second case, we include the external URL where the rule set was loaded from, and also RequestId if Network domain is enabled. See also: - https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-script - https://wicg.github.io/nav-speculation/speculation-rules.html#speculation-rules-header
OPTIONAL

url

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String url

[No Description Provided by Google]
OPTIONAL

requestId

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String requestId

[No Description Provided by Google]
OPTIONAL

errorType

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String errorType

Error information errorMessage is null iff errorType is null.
OPTIONAL

This particular field will have its values resricted to the contents of a CDP defined Enumerated String List. That list may be viewed here:

📎 Preload.RuleSetErrorType

Programmatically Accessing the Enum:

// Retrieve the list of enumerated strings for this field
ReadOnlyList<String> enumerationStrs = Preload.RuleSetErrorType.enumStrList("errorType");

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

See Also:

BaseType.enumStrList(String)

errorMessage

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String errorMessage

TODO(https://crbug.com/1425354): Replace this property with structured error.
OPTIONALDEPRECATED

Constructor Detail

RuleSet

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public RuleSet(ReadOnlyList<java.lang.Boolean> isPresent,
               java.lang.String id,
               java.lang.String loaderId,
               java.lang.String sourceText,
               java.lang.Integer backendNodeId,
               java.lang.String url,
               java.lang.String requestId,
               java.lang.String errorType,
               java.lang.String errorMessage)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Preload.RuleSet fromJSON(JsonObject jo)

Creates an instance of this class from a JsonObject.

Code:

Exact Method Body:

 return singleton.fromJSON(jo);

descriptor

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static NestedDescriptor<Preload.RuleSet> descriptor()

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

Code:

Exact Method Body:

 return singleton.descriptor();