Package android.os

Class PersistableBundle

java.lang.Object

android.os.BaseBundle

android.os.PersistableBundle

All Implemented Interfaces:

Parcelable, XmlUtils.WriteMapCallback, Cloneable

public final class PersistableBundle
extends BaseBundle
implements Cloneable, Parcelable, XmlUtils.WriteMapCallback

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

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field	Description
static Parcelable.Creator<PersistableBundle>	CREATOR
static PersistableBundle	EMPTY

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor	Description
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.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Clones the current PersistableBundle.
int	describeContents()	Report the nature of this Parcelable's contents
static PersistableBundle	forPair(String key, String value)	Make a PersistableBundle for a single key/value pair.
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.
static boolean	isValidType(Object value)
void	putPersistableBundle(String key, PersistableBundle value)	Inserts a PersistableBundle value into the mapping of this Bundle, replacing any existing value for the given key.
static PersistableBundle	restoreFromXml(XmlPullParser in)
void	saveToXml(XmlSerializer out)
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.
void	writeUnknownObject(Object v, String name, XmlSerializer out)	Called from writeMapXml when an Object type is not recognized.

Methods inherited from class android.os.BaseBundle

clear, containsKey, get, getDouble, getDouble, getDoubleArray, getInt, getInt, getIntArray, getLong, getLong, getLongArray, getPairValue, getString, getString, getStringArray, isEmpty, isParcelled, keySet, putAll, putDouble, putDoubleArray, putInt, putIntArray, putLong, putLongArray, putString, putStringArray, remove, size

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final PersistableBundle EMPTY

CREATOR

public static final Parcelable.Creator<PersistableBundle> CREATOR

Constructor Detail

PersistableBundle

public PersistableBundle()

Constructs a new, empty PersistableBundle.

PersistableBundle

public PersistableBundle(int capacity)

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

PersistableBundle

public PersistableBundle(PersistableBundle b)

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

Parameters:

b - a PersistableBundle to be copied.

Method Detail

isValidType

public static boolean isValidType(Object value)

forPair

public static PersistableBundle forPair(String key,
                                        String value)

Make a PersistableBundle for a single key/value pair.

clone

public Object clone()

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

Overrides:

clone in class Object

Returns:

a copy of this object.

putPersistableBundle

public void putPersistableBundle(String key,
                                 PersistableBundle value)

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

getPersistableBundle

public 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.

Parameters:

key - a String, or null

Returns:

a Bundle value, or null

writeUnknownObject

public void writeUnknownObject(Object v,
                               String name,
                               XmlSerializer out)
                        throws XmlPullParserException,
                               IOException

Description copied from interface: XmlUtils.WriteMapCallback

Called from writeMapXml when an Object type is not recognized. The implementer must write out the entire element including start and end tags.

Specified by:

writeUnknownObject in interface XmlUtils.WriteMapCallback

Parameters:

v - The object to be written out

name - The mapping key for v. Must be written into the "name" attribute of the start tag.

out - The XML output stream.

Throws:

XmlPullParserException - on unrecognized Object type.

IOException - on XmlSerializer serialization errors.

saveToXml

public void saveToXml(XmlSerializer out)
               throws IOException,
                      XmlPullParserException

Throws:

IOException

XmlPullParserException

describeContents

public int describeContents()

Report the nature of this Parcelable's contents

Specified by:

describeContents in interface Parcelable

Returns:

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

writeToParcel

public 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.

Specified by:

writeToParcel in interface Parcelable

Parameters:

parcel - The parcel to copy this bundle to.

flags - Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE.

restoreFromXml

public static PersistableBundle restoreFromXml(XmlPullParser in)
                                        throws IOException,
                                               XmlPullParserException

Throws:

IOException

XmlPullParserException

toString

public String toString()

Description copied from class: Object

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.

Overrides:

toString in class Object

Returns:

a printable representation of this object.