akasha

Class Storage

java.lang.Object

akasha.core.JsObject

akasha.Storage

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

The Storage interface of the Web Storage API provides access to a particular domain's session or local storage. It allows, for example, the addition, modification, or deletion of stored data items.

See Also:

Storage - MDN, (HTML) # storage

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Storage()

Method Summary

Modifier and Type	Method and Description
void	clear() The clear() method of the Storage interface clears all keys stored in a given Storage object.
@JsNullable java.lang.String	getItem(java.lang.String key) The getItem() method of the Storage interface, when passed a key name, will return that key's value, or null if the key does not exist, in the given Storage object.
@JsNullable java.lang.String	key(int index) The key() method of the Storage interface, when passed a number n, returns the name of the nth key in a given Storage object.
int	length() The length read-only property of the Storage interface returns the number of data items stored in a given Storage object.
void	removeItem(java.lang.String key) The removeItem() method of the Storage interface, when passed a key name, will remove that key from the given Storage object if it exists.
void	setItem(java.lang.String key, java.lang.String value) The setItem() method of the Storage interface, when passed a key name and value, will add that key to the given Storage object, or update that key's value if it already exists.

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

Storage

protected Storage()

Method Detail

length

@JsProperty(name="length")
public int length()

The length read-only property of the Storage interface returns the number of data items stored in a given Storage object.

See Also:

Storage.length - MDN, Storage.length - HTML Living Standard

clear

public void clear()

The clear() method of the Storage interface clears all keys stored in a given Storage object.

See Also:

Storage.clear - MDN, Storage.clear - HTML Living Standard

key

public @JsNullable java.lang.String key(int index)

The key() method of the Storage interface, when passed a number n, returns the name of the nth key in a given Storage object. The order of keys is user-agent defined, so you should not rely on it.

See Also:

Storage.key - MDN, Storage.key - HTML Living Standard

getItem

public @JsNullable java.lang.String getItem(@Nonnull
                                            java.lang.String key)

The getItem() method of the Storage interface, when passed a key name, will return that key's value, or null if the key does not exist, in the given Storage object.

See Also:

Storage.getItem - MDN, Storage.getItem - HTML Living Standard

setItem

public void setItem(@Nonnull
                    java.lang.String key,
                    @Nonnull
                    java.lang.String value)

The setItem() method of the Storage interface, when passed a key name and value, will add that key to the given Storage object, or update that key's value if it already exists.

See Also:

Storage.setItem - MDN, Storage.setItem - HTML Living Standard

removeItem

public void removeItem(@Nonnull
                       java.lang.String key)

The removeItem() method of the Storage interface, when passed a key name, will remove that key from the given Storage object if it exists. The Storage interface of the Web Storage API provides access to a particular domain's session or local storage.

See Also:

Storage.removeItem - MDN, Storage.removeItem - HTML Living Standard