Package org.loboevolution.js.webstorage

Interface Storage

All Known Implementing Classes:
LocalStorage, SessionStorage
public interface Storage
This Web Storage API interface provides access to a particular domain's session or local storage. It allows, for example, the addition, modification, or deletion of stored data items.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clear()
    Empties the list associated with the object of all key/value pairs, if there are any.
    Object
    getItem(String key)
    Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
    int
    getLength()
    getLength.
    Object
    key(int index)
    Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.
    void
    removeItem(String key)
    Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
    void
    setItem(String key, String value)
    Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.

  • Method Details

    • getLength

      int getLength()

      getLength.

      Returns:
      a Integer object.

    • clear

      void clear()
      Empties the list associated with the object of all key/value pairs, if there are any.

    • getItem

      Object getItem(String key)
      Returns the current value associated with the given key, or null if the given key does not exist in the list associated with the object.
      Parameters:
      key - a String object.
      Returns:
      a Object object.

    • key

      Object key(int index)
      Returns the name of the nth key in the list, or null if n is greater than or equal to the number of key/value pairs in the object.
      Parameters:
      index - a Integer object.
      Returns:
      a Object object.

    • removeItem

      void removeItem(String key)
      Removes the key/value pair with the given key from the list associated with the object, if a key/value pair with the given key exists.
      Parameters:
      key - a String object.

    • setItem

      void setItem(String key, String value)
      Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.

      Throws a "QuotaExceededError" DOMException exception if the new value couldn't be set. (Setting could fail if, e.g., the user has disabled storage for the site, or if the quota has been exceeded.)

      Parameters:
      key - a String object.
      value - a String object.