# Print output for @column tags ?> BaseBundle - Android SDK | Android Developers

Most visited

Recently visited

BaseBundle

public class BaseBundle
extends Object

java.lang.Object
   ↳ android.os.BaseBundle


A mapping from String keys to values of various types. In most cases, you should work directly with either the Bundle or PersistableBundle subclass.

Summary

Public methods

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)

Returns the value associated with the given key, or 0L 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[] 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)

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[] 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.

Inherited methods

Public methods

clear

public void clear ()

Removes all elements from the mapping of this Bundle.

containsKey

public boolean containsKey (String key)

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

Parameters
key String: a String key

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

get

public Object get (String key)

Returns the entry with the given key as an object.

Parameters
key String: a String key

Returns
Object an Object, or null

getBoolean

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 String: a String

defaultValue boolean: Value to return if key does not exist

Returns
boolean a boolean value

getBoolean

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 String: a String

Returns
boolean a boolean value

getBooleanArray

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

Parameters
key String: a String, or null This value may be null.

Returns
boolean[] a boolean[] value, or null

getDouble

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 String: a String

defaultValue double: Value to return if key does not exist

Returns
double a double value

getDouble

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 String: a String

Returns
double a double value

getDoubleArray

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

Parameters
key String: a String, or null This value may be null.

Returns
double[] a double[] value, or null

getInt

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 String: a String

Returns
int an int value

getInt

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 String: a String

defaultValue int: Value to return if key does not exist

Returns
int an int value

getIntArray

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

Parameters
key String: a String, or null This value may be null.

Returns
int[] an int[] value, or null

getLong

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 String: a String

Returns
long a long value

getLong

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 String: a String

defaultValue long: Value to return if key does not exist

Returns
long a long value

getLongArray

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

Parameters
key String: a String, or null This value may be null.

Returns
long[] a long[] value, or null

getString

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 String: a String, or null This value may be null.

Returns
String a String value, or null

getString

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

Parameters
key String: a String, or null This value may be null.

defaultValue String: Value to return if key does not exist or if a null value is associated with the given key.

Returns
String the String value associated with the given key, or defaultValue if no valid String object is currently mapped to that key.

getStringArray

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

Parameters
key String: a String, or null This value may be null.

Returns
String[] a String[] value, or null

isEmpty

public boolean isEmpty ()

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

Returns
boolean

keySet

public Set<String> keySet ()

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

Returns
Set<String> a Set of String keys

putAll

public void putAll (PersistableBundle bundle)

Inserts all mappings from the given PersistableBundle into this BaseBundle.

Parameters
bundle PersistableBundle: a PersistableBundle

putBoolean

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 String: a String, or null This value may be null.

value boolean: a boolean

putBooleanArray

public 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. Either key or value may be null.

Parameters
key String: a String, or null This value may be null.

value boolean: a boolean array object, or null This value may be null.

putDouble

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 String: a String, or null This value may be null.

value double: a double

putDoubleArray

public 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. Either key or value may be null.

Parameters
key String: a String, or null This value may be null.

value double: a double array object, or null This value may be null.

putInt

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 String: a String, or null This value may be null.

value int: an int

putIntArray

public 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. Either key or value may be null.

Parameters
key String: a String, or null This value may be null.

value int: an int array object, or null This value may be null.

putLong

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 String: a String, or null This value may be null.

value long: a long

putLongArray

public 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. Either key or value may be null.

Parameters
key String: a String, or null This value may be null.

value long: a long array object, or null This value may be null.

putString

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 String: a String, or null This value may be null.

value String: a String, or null This value may be null.

putStringArray

public 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. Either key or value may be null.

Parameters
key String: a String, or null This value may be null.

value String: a String array object, or null This value may be null.

remove

public void remove (String key)

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

Parameters
key String: a String key

size

public int size ()

Returns the number of mappings contained in this Bundle.

Returns
int the number of mappings as an int.