SavedState

In package com.nhaarman.acorn.state

class com.nhaarman.acorn.state.SavedState

Provides a container to be able to save state.

This interface uses a key-value strategy to store state.

Fields

abstract entries: Set

The set of entries that were saved in this container.

Methods

abstract fun clear(key: String)

Clears the value for given key.

Parameters:
  • key: String
abstract operator fun set(key: String, value: Boolean?)

Sets a boolean value for given key.

Parameters:
  • key: String
  • value: Boolean?
abstract operator fun set(key: String, value: Number?)

Sets a number value for given key.

Parameters:
  • key: String
  • value: Number?
abstract operator fun set(key: String, value: Char?)

Sets a char value for given key.

Parameters:
  • key: String
  • value: Char?
abstract operator fun set(key: String, value: String?)

Sets a String value for given key.

Parameters:
  • key: String
  • value: String?
abstract operator fun set(key: String, value: SavedState?)

Sets a SavedState value for given key.

Parameters:
abstract fun setUnchecked(key: String, value: Any?)

Sets any value for given key.

This method should be used with caution, as value types generally need to be serializable in some form. Failure to do so may cause in an Exception being thrown.

Parameters:
  • key: String
  • value: Any?
abstract fun getUnchecked(key: String): Any?

Retrieves the value for given key.

Parameters:
  • key: String

Extensions

inline operator fun <T : Any> SavedState.get(key: String): T?

Retrieves the value for given key and tries to cast it as a T.

If the value for given key is not of type T, null will be returned.

Parameters:
  • key: String
fun SavedState.toBundle():
Parameters:
  • No parameters