PersistableBundle - Android SDK

Added in API level 21

public final class

PersistableBundle

extends BaseBundle
implements Cloneable Parcelable

java.lang.Object
↳	android.os.BaseBundle
	↳	android.os.PersistableBundle

Class Overview

A mapping from String values to various types that can be saved to persistent and later restored.

Summary

[Expand]

Inherited Constants

From interface android.os.Parcelable

Fields
public static final Creator<PersistableBundle>	CREATOR
public static final PersistableBundle	EMPTY

Public Constructors
	PersistableBundle() Constructs a new, empty PersistableBundle.
	PersistableBundle(int capacity) Constructs a new, empty PersistableBundle sized to hold the given number of elements.
	PersistableBundle(PersistableBundle b) Constructs a PersistableBundle containing a copy of the mappings from the given PersistableBundle.

Public Methods
Object	clone() Clones the current PersistableBundle.
int	describeContents() Report the nature of this Parcelable's contents
PersistableBundle	getPersistableBundle(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
void	putPersistableBundle(String key, PersistableBundle value) Inserts a PersistableBundle value into the mapping of this Bundle, replacing any existing value for the given key.
synchronized String	toString() Returns a string containing a concise, human-readable description of this object.
void	writeToParcel(Parcel parcel, int flags) Writes the PersistableBundle contents to a Parcel, typically in order for it to be passed through an IBinder connection.

[Expand]

Inherited Methods

From class android.os.BaseBundle

void	clear() Removes all elements from the mapping of this Bundle.
boolean	containsKey(String key) Returns true if the given key is contained in the mapping of this Bundle.
Object	get(String key) Returns the entry with the given key as an object.
boolean	getBoolean(String key, boolean defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
boolean	getBoolean(String key) Returns the value associated with the given key, or false if no mapping of the desired type exists for the given key.
boolean[]	getBooleanArray(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
double	getDouble(String key, double defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
double	getDouble(String key) Returns the value associated with the given key, or 0.0 if no mapping of the desired type exists for the given key.
double[]	getDoubleArray(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
int	getInt(String key) Returns the value associated with the given key, or 0 if no mapping of the desired type exists for the given key.
int	getInt(String key, int defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
int[]	getIntArray(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
long	getLong(String key, long defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
long	getLong(String key) Returns the value associated with the given key, or 0L if no mapping of the desired type exists for the given key.
long[]	getLongArray(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
String	getString(String key, String defaultValue) Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key or if a null value is explicitly associated with the given key.
String	getString(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
String[]	getStringArray(String key) Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.
boolean	isEmpty() Returns true if the mapping of this Bundle is empty, false otherwise.
Set<String>	keySet() Returns a Set containing the Strings used as keys in this Bundle.
void	putAll(PersistableBundle bundle) Inserts all mappings from the given PersistableBundle into this BaseBundle.
void	putBoolean(String key, boolean value) Inserts a Boolean value into the mapping of this Bundle, replacing any existing value for the given key.
void	putBooleanArray(String key, boolean[] value) Inserts a boolean array value into the mapping of this Bundle, replacing any existing value for the given key.
void	putDouble(String key, double value) Inserts a double value into the mapping of this Bundle, replacing any existing value for the given key.
void	putDoubleArray(String key, double[] value) Inserts a double array value into the mapping of this Bundle, replacing any existing value for the given key.
void	putInt(String key, int value) Inserts an int value into the mapping of this Bundle, replacing any existing value for the given key.
void	putIntArray(String key, int[] value) Inserts an int array value into the mapping of this Bundle, replacing any existing value for the given key.
void	putLong(String key, long value) Inserts a long value into the mapping of this Bundle, replacing any existing value for the given key.
void	putLongArray(String key, long[] value) Inserts a long array value into the mapping of this Bundle, replacing any existing value for the given key.
void	putString(String key, String value) Inserts a String value into the mapping of this Bundle, replacing any existing value for the given key.
void	putStringArray(String key, String[] value) Inserts a String array value into the mapping of this Bundle, replacing any existing value for the given key.
void	remove(String key) Removes any entry with the given key from the mapping of this Bundle.
int	size() Returns the number of mappings contained in this Bundle.

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals(Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface android.os.Parcelable

Fields

public static final Creator<PersistableBundle> CREATOR

Added in API level 21

public static final PersistableBundle EMPTY

Added in API level 21

Public Constructors

public PersistableBundle ()

Added in API level 21

Constructs a new, empty PersistableBundle.

public PersistableBundle (int capacity)

Added in API level 21

Constructs a new, empty PersistableBundle sized to hold the given number of elements. The PersistableBundle will grow as needed.

Parameters

capacity	the initial capacity of the PersistableBundle

public PersistableBundle (PersistableBundle b)

Added in API level 21

Constructs a PersistableBundle containing a copy of the mappings from the given PersistableBundle.

Parameters

b	a PersistableBundle to be copied.

Public Methods

public Object clone ()

Added in API level 21

Clones the current PersistableBundle. The internal map is cloned, but the keys and values to which it refers are copied by reference.

Returns

a copy of this object.

public int describeContents ()

Added in API level 21

Report the nature of this Parcelable's contents

Returns

a bitmask indicating the set of special object types marshalled by the Parcelable.

public PersistableBundle getPersistableBundle (String key)

Added in API level 21

Returns the value associated with the given key, or null if no mapping of the desired type exists for the given key or a null value is explicitly associated with the key.

Parameters

key	a String, or null

Returns

a Bundle value, or null

public void putPersistableBundle (String key, PersistableBundle value)

Added in API level 21

Inserts a PersistableBundle value into the mapping of this Bundle, replacing any existing value for the given key. Either key or value may be null.

Parameters

key	a String, or null
value	a Bundle object, or null

public synchronized String toString ()

Added in API level 21

Returns a string containing a concise, human-readable description of this object. Subclasses are encouraged to override this method and provide an implementation that takes into account the object's type and data. The default implementation is equivalent to the following expression:

   getClass().getName() + '@' + Integer.toHexString(hashCode())

See Writing a useful toString method if you intend implementing your own toString method.

Returns

a printable representation of this object.

public void writeToParcel (Parcel parcel, int flags)

Added in API level 21

Writes the PersistableBundle contents to a Parcel, typically in order for it to be passed through an IBinder connection.

Parameters

parcel	The parcel to copy this bundle to.
flags	Additional flags about how the object should be written. May be 0 or `PARCELABLE_WRITE_RETURN_VALUE`.

Results

Interfaces

Classes

Enums

Exceptions

PersistableBundle

Class Overview

Summary

Fields

public static final Creator<PersistableBundle> CREATOR

public static final PersistableBundle EMPTY

Public Constructors

public PersistableBundle ()

public PersistableBundle (int capacity)

Parameters

public PersistableBundle (PersistableBundle b)

Parameters

Public Methods

public Object clone ()

Returns

public int describeContents ()

Returns

public PersistableBundle getPersistableBundle (String key)

Parameters

Returns

public void putPersistableBundle (String key, PersistableBundle value)

Parameters

public synchronized String toString ()

Returns

public void writeToParcel (Parcel parcel, int flags)

Parameters