com.smartgwt.mobile.client.data

Class Storage

java.lang.Object

com.smartgwt.mobile.client.data.Storage

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.String>

public class Storage
extends java.lang.Object
implements java.util.Map<java.lang.String,java.lang.String>

Map adapter for native browser Web Storage objects.

NOTE: Storage maps do not support null keys or values. This is because in tests of Google Chrome's Web Storage support, setting an entry with key null actually sets an entry with key "null". Similarly, setting an entry with value null actually sets an entry with value "null". Following the principle of least astonishment, Storage maps disallow null for keys and values.

See Also:

Web Storage - W3C

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storage.EntrySet
class	Storage.KeySet
static class	Storage.QuotaExceededException
class	Storage.StorageEntry
class	Storage.ValueCollection

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static Storage	LOCAL_STORAGE
static Storage	SESSION_STORAGE

Constructor Summary

Constructors

Constructor and Description
Storage(com.google.gwt.storage.client.Storage storage)

Method Summary

Modifier and Type	Method and Description
com.google.gwt.event.shared.HandlerRegistration	addStorageEventHandler(com.google.gwt.storage.client.StorageEvent.Handler handler)
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsKey(java.lang.String key)
boolean	containsValue(java.lang.Object value)
Storage.EntrySet	entrySet()
java.lang.String	get(java.lang.Object key)
java.lang.String	getKey(int i) Returns the key of the entry at index i.
boolean	isEmpty()
Storage.KeySet	keySet()
java.lang.String	put(java.lang.String key, java.lang.String value)
void	putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> map)
java.lang.String	remove(java.lang.Object key)
java.lang.String	remove(java.lang.String key)
int	size()
Storage.ValueCollection	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

LOCAL_STORAGE

public static final Storage LOCAL_STORAGE

SESSION_STORAGE

public static final Storage SESSION_STORAGE

Constructor Detail

Storage

public Storage(com.google.gwt.storage.client.Storage storage)

Method Detail

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,java.lang.String>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.String,java.lang.String>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,java.lang.String>

containsKey

public boolean containsKey(java.lang.String key)

containsValue

public boolean containsValue(java.lang.Object value)

Specified by:

containsValue in interface java.util.Map<java.lang.String,java.lang.String>

getKey

public java.lang.String getKey(int i)

Returns the key of the entry at index i.

Parameters:

i - index of entry.

Returns:

the key of the entry at index i.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if i is out of range.

get

public java.lang.String get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.String>

put

public java.lang.String put(java.lang.String key,
                            java.lang.String value)
                     throws Storage.QuotaExceededException

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.String>

Throws:

Storage.QuotaExceededException

remove

public java.lang.String remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.String>

remove

public java.lang.String remove(java.lang.String key)

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends java.lang.String> map)
            throws Storage.QuotaExceededException

Specified by:

putAll in interface java.util.Map<java.lang.String,java.lang.String>

Throws:

Storage.QuotaExceededException

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.String>

keySet

public Storage.KeySet keySet()

Specified by:

keySet in interface java.util.Map<java.lang.String,java.lang.String>

values

public Storage.ValueCollection values()

Specified by:

values in interface java.util.Map<java.lang.String,java.lang.String>

entrySet

public Storage.EntrySet entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.lang.String>

addStorageEventHandler

public com.google.gwt.event.shared.HandlerRegistration addStorageEventHandler(com.google.gwt.storage.client.StorageEvent.Handler handler)