Android - An Open Handset Alliance Project

android.os
public final class

android.os.Bundle

java.lang.Object
	android.os.Bundle	Parcelable Cloneable

A mapping from String values to various Parcelable types.

Summary

Constants

			Value
Creator	CREATOR
Bundle	EMPTY

Public Constructors

					Bundle()
					Constructs a new, empty Bundle.
					Bundle(ClassLoader loader)
					Constructs a new, empty Bundle that uses a specific ClassLoader for instantiating Parcelable and Serializable objects.
					Bundle(int capacity)
					Constructs a new, empty Bundle sized to hold the given number of elements.
					Bundle(Bundle b)
					Constructs a Bundle containing a copy of the mappings from the given Bundle.

Public Methods

	void	clear()
		Removes all elements from the mapping of this Bundle.
	Object	clone()
		Clones the current 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)
		Returns the value associated with the given key, or false if no mapping of the desired type exists for the given key.
	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.
	Bundle	getBundle(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.
	Byte	getByte(String key, byte defaultValue)
		Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
	byte	getByte(String key)
		Returns the value associated with the given key, or (byte) 0 if no mapping of the desired type exists for the given key.
	char	getChar(String key, char defaultValue)
		Returns the value associated with the given key, or (char) 0 if no mapping of the desired type exists for the given key.
	char	getChar(String key)
		Returns the value associated with the given key, or false if no mapping of the desired type exists for the given key.
	CharSequence	getCharSequence(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.
	float	getFloat(String key, float defaultValue)
		Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
	float	getFloat(String key)
		Returns the value associated with the given key, or 0.0f if no mapping of the desired type exists for the given key.
	IBinder	getIBinder(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.
	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.
	Parcelable	getParcelable(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.
	Parcelable[]	getParcelableArray(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.
	Serializable	getSerializable(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.
	short	getShort(String key)
		Returns the value associated with the given key, or (short) 0 if no mapping of the desired type exists for the given key.
	short	getShort(String key, short defaultValue)
		Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.
	SparseArray	getSparseParcelableArray(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)
		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	keySet()
		Returns a Set containing the Strings used as keys in this Bundle.
	void	putAll(Bundle map)
		Inserts all mappings from the given Bundle into this Bundle.
	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	putBundle(String key, Bundle value)
		Inserts a Bundle value into the mapping of this Bundle, replacing any existing value for the given key.
	void	putByte(String key, byte value)
		Inserts a byte value into the mapping of this Bundle, replacing any existing value for the given key.
	void	putChar(String key, char value)
		Inserts a char value into the mapping of this Bundle, replacing any existing value for the given key.
	void	putCharSequence(String key, CharSequence value)
		Inserts a CharSequence 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	putFloat(String key, float value)
		Inserts a float value into the mapping of this Bundle, replacing any existing value for the given key.
	void	putIBinder(String key, IBinder value)
		Inserts an IBinder 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	putLong(String key, long value)
		Inserts a long value into the mapping of this Bundle, replacing any existing value for the given key.
	void	putParcelable(String key, Parcelable value)
		Inserts a Parcelable value into the mapping of this Bundle, replacing any existing value for the given key.
	void	putParcelableArray(String key, Parcelable[] value)
		Inserts an array of Parcelable values into the mapping of this Bundle, replacing any existing value for the given key.
	void	putSerializable(String key, Serializable value)
		Inserts a Serializable value into the mapping of this Bundle, replacing any existing value for the given key.
	void	putShort(String key, short value)
		Inserts a short value into the mapping of this Bundle, replacing any existing value for the given key.
	void	putSparceParcelableArray(String key, SparseArray value)
		Inserts a SparceArray of Parcelable values 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	remove(String key)
		Removes any entry with the given key from the mapping of this Bundle.
	void	setClassLoader(ClassLoader loader)
		Changes the ClassLoader this Bundle uses when instantiating objects.
	int	size()
		Returns the number of mappings contained in this Bundle.
synchronized	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
	void	writeToParcel(Parcel parcel)
		Writes the Bundle contents to a Parcel, typically in order for it to be passed through an IBinder connection.

Methods inherited from class java.lang.Object

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

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Methods inherited from interface android.os.Parcelable

writeToParcel

Details

Constants

public static final Creator CREATOR

public static final Bundle EMPTY

Public Constructors

public Bundle()

Constructs a new, empty Bundle.

public Bundle(ClassLoader loader)

Constructs a new, empty Bundle that uses a specific ClassLoader for instantiating Parcelable and Serializable objects.

Parameters

loader	An explicit ClassLoader to use when instantiating objects inside of the Bundle.

public Bundle(int capacity)

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

Parameters

capacity	the initial capacity of the Bundle

public Bundle(Bundle b)

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

Parameters

b	a Bundle to be copied.

Public Methods

public void clear()

Removes all elements from the mapping of this Bundle.

public Object clone()

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

public boolean containsKey(String key)

Returns true if the given key is contained in the mapping of this Bundle.

Parameters

key	a String key

Returns

true if the key is part of the mapping, false otherwise

public Object get(String key)

Returns the entry with the given key as an object.

Parameters

key	a String key

Returns

an Object, or null

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

Parameters

key	a String

Returns

a boolean value

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

Parameters

key	a String

Returns

a boolean value

public Bundle getBundle(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

public Byte getByte(String key, byte defaultValue)

Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.

Parameters

key	a String

Returns

a byte value

public byte getByte(String key)

Returns the value associated with the given key, or (byte) 0 if no mapping of the desired type exists for the given key.

Parameters

key	a String

Returns

a byte value

public char getChar(String key, char defaultValue)

Returns the value associated with the given key, or (char) 0 if no mapping of the desired type exists for the given key.

Parameters

key	a String

Returns

a char value

public char getChar(String key)

Returns the value associated with the given key, or false if no mapping of the desired type exists for the given key.

Parameters

key	a String

Returns

a char value

public CharSequence getCharSequence(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 CharSequence value, or null

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

Parameters

key	a String

Returns

a double value

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

Parameters

key	a String

Returns

a double value

public float getFloat(String key, float defaultValue)

Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.

Parameters

key	a String

Returns

a float value

public float getFloat(String key)

Returns the value associated with the given key, or 0.0f if no mapping of the desired type exists for the given key.

Parameters

key	a String

Returns

a float value

public IBinder getIBinder(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

an IBinder value, or null

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

Parameters

key	a String

Returns

an int value

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

Parameters

key	a String

Returns

an int value

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

Parameters

key	a String

Returns

a long value

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

Parameters

key	a String

Returns

a long value

public Parcelable getParcelable(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 Parcelable value, or null

public Parcelable[] getParcelableArray(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 Parcelable[] value, or null

public Serializable getSerializable(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 Serializable value, or null

public short getShort(String key)

Returns the value associated with the given key, or (short) 0 if no mapping of the desired type exists for the given key.

Parameters

key	a String

Returns

a short value

public short getShort(String key, short defaultValue)

Returns the value associated with the given key, or defaultValue if no mapping of the desired type exists for the given key.

Parameters

key	a String

Returns

a short value

public SparseArray getSparseParcelableArray(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 SparseArray of Parcelable values, or null

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

Parameters

key	a String, or null

Returns

a String value, or null

public boolean isEmpty()

Returns true if the mapping of this Bundle is empty, false otherwise.

public Set keySet()

Returns a Set containing the Strings used as keys in this Bundle.

Returns

a Set of String keys

public void putAll(Bundle map)

Inserts all mappings from the given Bundle into this Bundle.

Parameters

map	a Bundle

public void putBoolean(String key, boolean value)

Inserts a Boolean 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 Boolean, or null

public void putBundle(String key, Bundle value)

Inserts a Bundle 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 void putByte(String key, byte value)

Inserts a byte value into the mapping of this Bundle, replacing any existing value for the given key.

Parameters

key	a String, or null
value	a byte

public void putChar(String key, char value)

Inserts a char value into the mapping of this Bundle, replacing any existing value for the given key.

Parameters

key	a String, or null
value	a char, or null

public void putCharSequence(String key, CharSequence value)

Inserts a CharSequence 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 CharSequence, or null

public void putDouble(String key, double value)

Inserts a double value into the mapping of this Bundle, replacing any existing value for the given key.

Parameters

key	a String, or null
value	a double

public void putFloat(String key, float value)

Inserts a float value into the mapping of this Bundle, replacing any existing value for the given key.

Parameters

key	a String, or null
value	a float

public void putIBinder(String key, IBinder value)

Inserts an IBinder 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	an IBinder object, or null

public void putInt(String key, int value)

Inserts an int value into the mapping of this Bundle, replacing any existing value for the given key.

Parameters

key	a String, or null
value	an int, or null

public void putLong(String key, long value)

Inserts a long value into the mapping of this Bundle, replacing any existing value for the given key.

Parameters

key	a String, or null
value	a long

public void putParcelable(String key, Parcelable value)

Inserts a Parcelable 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 Parcelable object, or null

public void putParcelableArray(String key, Parcelable[] value)

Inserts an array of Parcelable values 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	an array of Parcelable objects, or null

public void putSerializable(String key, Serializable value)

Inserts a Serializable 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 Serializable object, or null

public void putShort(String key, short value)

Inserts a short value into the mapping of this Bundle, replacing any existing value for the given key.

Parameters

key	a String, or null
value	a short

public void putSparceParcelableArray(String key, SparseArray value)

Inserts a SparceArray of Parcelable values 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 SparseArray of Parcelable objects, or null

public void putString(String key, String value)

Inserts a String 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 String, or null

public void remove(String key)

Removes any entry with the given key from the mapping of this Bundle.

Parameters

key	a String key

public void setClassLoader(ClassLoader loader)

Changes the ClassLoader this Bundle uses when instantiating objects.

Parameters

loader	An explicit ClassLoader to use when instantiating objects inside of the Bundle.

public int size()

Returns the number of mappings contained in this Bundle.

Returns

the number of mappings as an int.

public synchronized String toString()

Answers a string containing a concise, human-readable description of the receiver.

public void writeToParcel(Parcel parcel)

Writes the Bundle 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.


e.g. "intent" or "activity"

Android - An Open Handset Alliance Project

Documentation

Goodies

android.os.Bundle

Summary

Constants

Public Constructors

Public Methods

Methods inherited from class java.lang.Object

Methods inherited from interface android.os.Parcelable

Details

Constants

public static final Creator CREATOR

public static final Bundle EMPTY

Public Constructors

public Bundle()

public Bundle(ClassLoader loader)

Parameters

public Bundle(int capacity)

Parameters

public Bundle(Bundle b)

Parameters

Public Methods

public void clear()

public Object clone()

public boolean containsKey(String key)

Parameters

Returns

public Object get(String key)

Parameters

Returns

public boolean getBoolean(String key)

Parameters

Returns

public boolean getBoolean(String key, boolean defaultValue)

Parameters

Returns

public Bundle getBundle(String key)

Parameters

Returns

public Byte getByte(String key, byte defaultValue)

Parameters

Returns

public byte getByte(String key)

Parameters

Returns

public char getChar(String key, char defaultValue)

Parameters

Returns

public char getChar(String key)

Parameters

Returns

public CharSequence getCharSequence(String key)

Parameters

Returns

public double getDouble(String key, double defaultValue)

Parameters

Returns

public double getDouble(String key)

Parameters

Returns

public float getFloat(String key, float defaultValue)

Parameters

Returns

public float getFloat(String key)

Parameters

Returns

public IBinder getIBinder(String key)

Parameters

Returns

public int getInt(String key)

Parameters

Returns

public int getInt(String key, int defaultValue)

Parameters

Returns

public long getLong(String key, long defaultValue)

Parameters

Returns

public long getLong(String key)