Package Torello.Browser.BrowserAPI

Class IndexedDB.KeyPath

java.lang.Object

Torello.Browser.BaseType<IndexedDB.KeyPath>

Torello.Browser.BrowserAPI.IndexedDB.KeyPath

All Implemented Interfaces:

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

Enclosing class:

IndexedDB

public static class IndexedDB.KeyPath
extends BaseType<IndexedDB.KeyPath>
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 IndexedDB 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.

Key path.

See Also:

Serialized Form

Hi-Lited Source-Code:

This File's Source Code:

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

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

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

File Size: 8,826 Bytes Line Count: 230 '\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[]	array	Array value.
String	string	String value.
String	type	Key path type.

Fields inherited from class Torello.Browser.BaseType

domain, helperSingleton, isPresent, name, numFields

Constructor Summary

Constructors

Constructor	Description
KeyPath(ReadOnlyList<Boolean> isPresent, String type, String string, String[] array)	Constructor.

Method Summary

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

type

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String type

Key path type.

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

📎 IndexedDB$$KeyPath$$

Programmatically Accessing the Enum:

// Retrieve the list of enumerated strings for this field
ReadOnlyList<String> enumerationStrs = IndexedDB.KeyPath.enumStrList("type");

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

See Also:

BaseType.enumStrList(String)

string

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String string

String value.
OPTIONAL

array

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public final java.lang.String[] array

Array value.
OPTIONAL

Constructor Detail

KeyPath

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public KeyPath(ReadOnlyList<java.lang.Boolean> isPresent,
               java.lang.String type,
               java.lang.String string,
               java.lang.String[] array)

Constructor. Please review this class' fields for documentation.

Method Detail

fromJSON

🡅 🡇 ⇈ ⮫ 🗕 🗗 🗖

public static IndexedDB.KeyPath fromJSON(JsonObject jo)

Creates an instance of this class from a JsonObject.

Code:

Exact Method Body:

 return singleton.fromJSON(jo);

descriptor

🡅 ⇈ ⮫ 🗕 🗗 🗖

public static NestedDescriptor<IndexedDB.KeyPath> descriptor()

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

Code:

Exact Method Body:

 return singleton.descriptor();