Package Torello.Browser.BrowserAPI

Class Browser.downloadProgress

java.lang.Object

Torello.Browser.BaseType<DOMAIN_NESTED>

Torello.Browser.BrowserEvent<Browser.downloadProgress>

Torello.Browser.BrowserAPI.Browser.downloadProgress

All Implemented Interfaces:

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

Enclosing class:

Browser

public static class Browser.downloadProgress
extends BrowserEvent<Browser.downloadProgress>
implements java.io.Serializable

This Nested Java Class is declared as an Event-Type by the CDP API Specifications. This class largely functions as a data container or "data record", and encapsulates the datum values that Google Chrome is incorporating into the event that it is firing.

📌 All browser domain event classes will have a class name that begins with a lower case letter.

👉 Note that this particular event can be fired by the Browser domain, located in the BrowserAPI. A browser 'domain' is quite similar to a Java Package. It incorporates a suite of features, types and functions under one umbrella.

Fired when download makes progress. Last call has |done| == true.
EXPERIMENTAL

See Also:

Serialized Form

Hi-Lited Source-Code:

This File's Source Code:

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

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

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

File Size: 9,890 Bytes Line Count: 245 '\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	filePath	If download is "completed", provides the path of the downloaded file.
String	guid	Global unique identifier of the download.
Number	receivedBytes	Total bytes received.
String	state	Download status.
Number	totalBytes	Total expected bytes to download.

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
downloadProgress(ReadOnlyList<Boolean> isPresent, String guid, Number totalBytes, Number receivedBytes, String state, String filePath)	Constructor.

Method Summary

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

guid

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String guid

Global unique identifier of the download.

totalBytes

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Number totalBytes

Total expected bytes to download.

receivedBytes

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.Number receivedBytes

Total bytes received.

state

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String state

Download status.

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 'state$$':

📎 Browser$$downloadProgress$$

Programmatically Accessing the Enum:

// Retrieve the list of enumerated strings for this field
ReadOnlyList<String> enumerationStrs = Browser.downloadProgress.enumStrList("state");

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

See Also:

BaseType.enumStrList(String)

filePath

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String filePath

If download is "completed", provides the path of the downloaded file. Depending on the platform, it is not guaranteed to be set, nor the file is guaranteed to exist.
OPTIONALEXPERIMENTAL

Constructor Detail

downloadProgress

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public downloadProgress(ReadOnlyList<java.lang.Boolean> isPresent,
                        java.lang.String guid,
                        java.lang.Number totalBytes,
                        java.lang.Number receivedBytes,
                        java.lang.String state,
                        java.lang.String filePath)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static Browser.downloadProgress fromJSON(JsonObject jo)

Creates an instance of this class from a JsonObject.

Code:

Exact Method Body:

 return singleton.fromJSON(jo);

descriptor

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static NestedDescriptor<Browser.downloadProgress> descriptor()

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

Code:

Exact Method Body:

 return singleton.descriptor();