Package org.vaadin.firitin.util

Class WebStorage

java.lang.Object

org.vaadin.firitin.util.WebStorage

public class WebStorage
extends Object

Wrapper for similarly named Browser API. WebStorage may be handy to save some data that you want to be stored on the client side, instead of e.g. database on the server. An example could be certain UI settings that the same users might want to have set differently based on their device.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WebStorage.Callback
static class	WebStorage.Storage

Constructor Summary

Constructors

Constructor	Description
WebStorage()

Method Summary

Modifier and Type	Method	Description
static void	clear()	Clears all values from the Storage.localStorage
static void	clear(com.vaadin.flow.component.UI ui, WebStorage.Storage storage)	Clears the given storage.
static void	clear(WebStorage.Storage storage)	Clears the given storage.
static void	getItem(com.vaadin.flow.component.UI ui, WebStorage.Storage storage, String key, WebStorage.Callback callback)	Asynchronously gets an item from the given storage
static void	getItem(String key, WebStorage.Callback callback)	Asynchronously gets an item from the Storage.localStorage
static void	getItem(WebStorage.Storage storage, String key, WebStorage.Callback callback)	Asynchronously gets an item from the given storage
static void	removeItem(com.vaadin.flow.component.UI ui, WebStorage.Storage storage, String key)	Removes the value associated by the given key from the Storage.localStorage
static void	removeItem(String key)	Removes the value associated by the given key from the Storage.localStorage
static void	removeItem(WebStorage.Storage storage, String key)	Removes the value associated by the given key from the Storage.localStorage
static void	setItem(com.vaadin.flow.component.UI ui, WebStorage.Storage storage, String key, String value)	Sets given key-value pair to give storage type
static void	setItem(String key, String value)	Sets given key-value pair to Storage.localStorage
static void	setItem(WebStorage.Storage storage, String key, String value)	Sets given key-value pair to give storage type

Methods inherited from class java.lang.Object

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

Constructor Detail

WebStorage

public WebStorage()

Method Detail

setItem

public static void setItem(String key,
                           String value)

Sets given key-value pair to Storage.localStorage

Parameters:

key - the key

value - the value

setItem

public static void setItem(WebStorage.Storage storage,
                           String key,
                           String value)

Sets given key-value pair to give storage type

Parameters:

storage - the storage type

key - the key

value - the value

setItem

public static void setItem(com.vaadin.flow.component.UI ui,
                           WebStorage.Storage storage,
                           String key,
                           String value)

Sets given key-value pair to give storage type

Parameters:

ui - the UI for which the storage is related to

storage - the storage type

key - the key

value - the value

removeItem

public static void removeItem(String key)

Removes the value associated by the given key from the Storage.localStorage

Parameters:

key - the key to be deleted

removeItem

public static void removeItem(WebStorage.Storage storage,
                              String key)

Removes the value associated by the given key from the Storage.localStorage

Parameters:

storage - the storage type from which the value will be removed

key - the key to be deleted

removeItem

public static void removeItem(com.vaadin.flow.component.UI ui,
                              WebStorage.Storage storage,
                              String key)

Removes the value associated by the given key from the Storage.localStorage

Parameters:

ui - the UI for which the storage is related to

storage - the storage type from which the value will be removed

key - the key to be deleted

clear

public static void clear()

Clears all values from the Storage.localStorage

clear

public static void clear(WebStorage.Storage storage)

Clears the given storage.

Parameters:

storage - the storage

clear

public static void clear(com.vaadin.flow.component.UI ui,
                         WebStorage.Storage storage)

Clears the given storage.

Parameters:

ui - the UI for which the storage is related to

storage - the storage

getItem

public static void getItem(String key,
                           WebStorage.Callback callback)

Asynchronously gets an item from the Storage.localStorage

Parameters:

key - the key for which the value will be fetched

callback - the callback that gets the value once transferred from the client side

getItem

public static void getItem(WebStorage.Storage storage,
                           String key,
                           WebStorage.Callback callback)

Asynchronously gets an item from the given storage

Parameters:

storage - the storage

key - the key for which the value will be fetched

callback - the callback that gets the value once transferred from the client side

getItem

public static void getItem(com.vaadin.flow.component.UI ui,
                           WebStorage.Storage storage,
                           String key,
                           WebStorage.Callback callback)

Asynchronously gets an item from the given storage

Parameters:

ui - the UI for which the storage is related to

storage - the storage

key - the key for which the value will be fetched

callback - the callback that gets the value once transferred from the client side