akasha.idb

Class IDBCursor

java.lang.Object

akasha.core.JsObject

akasha.idb.IDBCursor

Direct Known Subclasses:

IDBCursorWithValue

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="IDBCursor")
public class IDBCursor
extends JsObject

The IDBCursor interface of the IndexedDB API represents a cursor for traversing or iterating over multiple records in a database.

See Also:

IDBCursor - MDN, (Indexed DB 3.0) # cursor-interface

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IDBCursor()

Method Summary

Modifier and Type	Method and Description
void	advance(int count) The advance() method of the IDBCursor interface sets the number of times a cursor should move its position forward.
void	continue_()
void	continue_(java.lang.Object key)
void	continuePrimaryKey(java.lang.Object key, java.lang.Object primaryKey) The continuePrimaryKey() method of the IDBCursor interface advances the cursor to the to the item whose key matches the key parameter as well as whose primary key matches the primary key parameter.
IDBRequest	delete() The delete() method of the IDBCursor interface returns an IDBRequest object, and, in a separate thread, deletes the record at the cursor's position, without changing the cursor's position.
java.lang.String	direction() A string (defined by the IDBCursorDirection enum) indicating the direction in which the cursor is traversing the data.
jsinterop.base.Any	key() A value of any type.
jsinterop.base.Any	primaryKey() A value of any data type.
IDBRequest	request() The request read-only property of the IDBCursor interface returns the IDBRequest used to obtain the cursor.
IDBObjectStoreOrIDBIndexUnion	source() The IDBObjectStore or IDBIndex that the cursor is iterating over.
IDBRequest	update(java.lang.Object value) The update() method of the IDBCursor interface returns an IDBRequest object, and, in a separate thread, updates the value at the current position of the cursor in the object store.

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IDBCursor

protected IDBCursor()

Method Detail

direction

@JsProperty(name="direction")
 @Nonnull
 @IDBCursorDirection
public java.lang.String direction()

A string (defined by the IDBCursorDirection enum) indicating the direction in which the cursor is traversing the data. Possible values are:

See Also:

IDBCursor.direction - MDN, direction - Indexed Database API 2.0, direction - Indexed Database API Draft

key

@JsProperty(name="key")
 @Nullable
public jsinterop.base.Any key()

A value of any type.

See Also:

IDBCursor.key - MDN, key - Indexed Database API 2.0, key - Indexed Database API Draft

primaryKey

@JsProperty(name="primaryKey")
 @Nullable
public jsinterop.base.Any primaryKey()

A value of any data type.

See Also:

IDBCursor.primaryKey - MDN, primaryKey - Indexed Database API 2.0, primaryKey - Indexed Database API Draft

request

@JsProperty(name="request")
 @Nonnull
public IDBRequest request()

The request read-only property of the IDBCursor interface returns the IDBRequest used to obtain the cursor.

See Also:

IDBCursor.request - MDN

source

@JsProperty(name="source")
 @Nonnull
public IDBObjectStoreOrIDBIndexUnion source()

The IDBObjectStore or IDBIndex that the cursor is iterating over.

See Also:

IDBCursor.source - MDN, source - Indexed Database API 2.0, source - Indexed Database API Draft

advance

public void advance(int count)

The advance() method of the IDBCursor interface sets the number of times a cursor should move its position forward.

See Also:

IDBCursor.advance - MDN, advance() - Indexed Database API 2.0, advance() - Indexed Database API Draft

continue_

@JsMethod(name="continue")
public void continue_(@Nullable
                                                 java.lang.Object key)

continue_

@JsMethod(name="continue")
public void continue_()

continuePrimaryKey

public void continuePrimaryKey(@Nullable
                               java.lang.Object key,
                               @Nullable
                               java.lang.Object primaryKey)

The continuePrimaryKey() method of the IDBCursor interface advances the cursor to the to the item whose key matches the key parameter as well as whose primary key matches the primary key parameter.

See Also:

IDBCursor.continuePrimaryKey - MDN, continuePrimaryKey() - Indexed Database API Draft

delete

@Nonnull
public IDBRequest delete()

The delete() method of the IDBCursor interface returns an IDBRequest object, and, in a separate thread, deletes the record at the cursor's position, without changing the cursor's position. Once the record is deleted, the cursor's value is set to null.

See Also:

IDBCursor.delete - MDN, delete() - Indexed Database API 2.0, delete() - Indexed Database API Draft

update

@Nonnull
public IDBRequest update(@Nullable
                                  java.lang.Object value)

The update() method of the IDBCursor interface returns an IDBRequest object, and, in a separate thread, updates the value at the current position of the cursor in the object store. If the cursor points to a record that has just been deleted, a new record is created.

See Also:

IDBCursor.update - MDN, update() - Indexed Database API 2.0, update() - Indexed Database API Draft