ContentValues

public final class ContentValues
extends Object implements Parcelable

java.lang.Object
   ↳ android.content.ContentValues


This class is used to store a set of values that the ContentResolver can process.

Summary

Constants

String TAG

Inherited constants

Fields

public static final Creator<ContentValues> CREATOR

Public constructors

ContentValues()

Creates an empty set of values using the default initial size

ContentValues(int size)

Creates an empty set of values using the given initial size

ContentValues(ContentValues from)

Creates a set of values copied from the given set

Public methods

void clear()

Removes all values.

boolean containsKey(String key)

Returns true if this object has the named value.

int describeContents()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.

boolean equals(Object object)

Indicates whether some other object is "equal to" this one.

Object get(String key)

Gets a value.

Boolean getAsBoolean(String key)

Gets a value and converts it to a Boolean.

Byte getAsByte(String key)

Gets a value and converts it to a Byte.

byte[] getAsByteArray(String key)

Gets a value that is a byte array.

Double getAsDouble(String key)

Gets a value and converts it to a Double.

Float getAsFloat(String key)

Gets a value and converts it to a Float.

Integer getAsInteger(String key)

Gets a value and converts it to an Integer.

Long getAsLong(String key)

Gets a value and converts it to a Long.

Short getAsShort(String key)

Gets a value and converts it to a Short.

String getAsString(String key)

Gets a value and converts it to a String.

int hashCode()

Returns a hash code value for the object.

boolean isEmpty()

Indicates whether this collection is empty.

Set<String> keySet()

Returns a set of all of the keys

void put(String key, Short value)

Adds a value to the set.

void put(String key, Long value)

Adds a value to the set.

void put(String key, Double value)

Adds a value to the set.

void put(String key, Integer value)

Adds a value to the set.

void put(String key, String value)

Adds a value to the set.

void put(String key, Boolean value)

Adds a value to the set.

void put(String key, Float value)

Adds a value to the set.

void put(String key, byte[] value)

Adds a value to the set.

void put(String key, Byte value)

Adds a value to the set.

void putAll(ContentValues other)

Adds all values from the passed in ContentValues.

void putNull(String key)

Adds a null value to the set.

void remove(String key)

Remove a single value.

int size()

Returns the number of values.

String toString()

Returns a string containing a concise, human-readable description of this object.

Set<Entry<StringObject>> valueSet()

Returns a set of all of the keys and values

void writeToParcel(Parcel parcel, int flags)

Flatten this object in to a Parcel.

Inherited methods

Constants

TAG

Added in API level 1
public static final String TAG

Constant Value: "ContentValues"

Fields

CREATOR

Added in API level 1
public static final Creator<ContentValues> CREATOR

Public constructors

ContentValues

Added in API level 1
public ContentValues ()

Creates an empty set of values using the default initial size

ContentValues

Added in API level 1
public ContentValues (int size)

Creates an empty set of values using the given initial size

Parameters
size int: the initial size of the set of values

ContentValues

Added in API level 1
public ContentValues (ContentValues from)

Creates a set of values copied from the given set

Parameters
from ContentValues: the values to copy

Public methods

clear

Added in API level 1
public void clear ()

Removes all values.

containsKey

Added in API level 1
public boolean containsKey (String key)

Returns true if this object has the named value.

Parameters
key String: the value to check for

Returns
boolean true if the value is present, false otherwise

describeContents

Added in API level 1
public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 1
public boolean equals (Object object)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
object Object: This value may be null.

Returns
boolean true if this object is the same as the obj argument; false otherwise.

get

Added in API level 1
public Object get (String key)

Gets a value. Valid value types are String, Boolean, Number, and byte[] implementations.

Parameters
key String: the value to get

Returns
Object the data for the value, or null if the value is missing or if null was previously added with the given key

getAsBoolean

Added in API level 1
public Boolean getAsBoolean (String key)

Gets a value and converts it to a Boolean.

Parameters
key String: the value to get

Returns
Boolean the Boolean value, or null if the value is missing or cannot be converted

getAsByte

Added in API level 1
public Byte getAsByte (String key)

Gets a value and converts it to a Byte.

Parameters
key String: the value to get

Returns
Byte the Byte value, or null if the value is missing or cannot be converted

getAsByteArray

Added in API level 1
public byte[] getAsByteArray (String key)

Gets a value that is a byte array. Note that this method will not convert any other types to byte arrays.

Parameters
key String: the value to get

Returns
byte[] the byte[] value, or null is the value is missing or not a byte[]

getAsDouble

Added in API level 1
public Double getAsDouble (String key)

Gets a value and converts it to a Double.

Parameters
key String: the value to get

Returns
Double the Double value, or null if the value is missing or cannot be converted

getAsFloat

Added in API level 1
public Float getAsFloat (String key)

Gets a value and converts it to a Float.

Parameters
key String: the value to get

Returns
Float the Float value, or null if the value is missing or cannot be converted

getAsInteger

Added in API level 1
public Integer getAsInteger (String key)

Gets a value and converts it to an Integer.

Parameters
key String: the value to get

Returns
Integer the Integer value, or null if the value is missing or cannot be converted

getAsLong

Added in API level 1
public Long getAsLong (String key)

Gets a value and converts it to a Long.

Parameters
key String: the value to get

Returns
Long the Long value, or null if the value is missing or cannot be converted

getAsShort

Added in API level 1
public Short getAsShort (String key)

Gets a value and converts it to a Short.

Parameters
key String: the value to get

Returns
Short the Short value, or null if the value is missing or cannot be converted

getAsString

Added in API level 1
public String getAsString (String key)

Gets a value and converts it to a String.

Parameters
key String: the value to get

Returns
String the String for the value

hashCode

Added in API level 1
public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int a hash code value for this object.

isEmpty

Added in API level 30
public boolean isEmpty ()

Indicates whether this collection is empty.

Returns
boolean true iff size == 0

keySet

Added in API level 11
public Set<String> keySet ()

Returns a set of all of the keys

Returns
Set<String> a set of all of the keys

put

Added in API level 1
public void put (String key, 
                Short value)

Adds a value to the set.

Parameters
key String: the name of the value to put

value Short: the data for the value to put

put

Added in API level 1
public void put (String key, 
                Long value)

Adds a value to the set.

Parameters
key String: the name of the value to put

value Long: the data for the value to put

put

Added in API level 1
public void put (String key, 
                Double value)

Adds a value to the set.

Parameters
key String: the name of the value to put

value Double: the data for the value to put

put

Added in API level 1
public void put (String key, 
                Integer value)

Adds a value to the set.

Parameters
key String: the name of the value to put

value Integer: the data for the value to put

put

Added in API level 1
public void put (String key, 
                String value)

Adds a value to the set.

Parameters
key String: the name of the value to put

value String: the data for the value to put

put

Added in API level 1
public void put (String key, 
                Boolean value)

Adds a value to the set.

Parameters
key String: the name of the value to put

value Boolean: the data for the value to put

put

Added in API level 1
public void put (String key, 
                Float value)

Adds a value to the set.

Parameters
key String: the name of the value to put

value Float: the data for the value to put

put

Added in API level 1
public void put (String key, 
                byte[] value)

Adds a value to the set.

Parameters
key String: the name of the value to put

value byte: the data for the value to put

put

Added in API level 1
public void put (String key, 
                Byte value)

Adds a value to the set.

Parameters
key String: the name of the value to put

value Byte: the data for the value to put

putAll

Added in API level 1
public void putAll (ContentValues other)

Adds all values from the passed in ContentValues.

Parameters
other ContentValues: the ContentValues from which to copy

putNull

Added in API level 1
public void putNull (String key)

Adds a null value to the set.

Parameters
key String: the name of the value to make null

remove

Added in API level 1
public void remove (String key)

Remove a single value.

Parameters
key String: the name of the value to remove

size

Added in API level 1
public int size ()

Returns the number of values.

Returns
int the number of values

toString

Added in API level 1
public String toString ()

Returns a string containing a concise, human-readable description of this object.

Returns
String a printable representation of this object.

valueSet

Added in API level 1
public Set<Entry<StringObject>> valueSet ()

Returns a set of all of the keys and values

Returns
Set<Entry<StringObject>> a set of all of the keys and values

writeToParcel

Added in API level 1
public void writeToParcel (Parcel parcel, 
                int flags)

Flatten this object in to a Parcel.

Parameters
parcel Parcel: The Parcel in which the object should be written. This value cannot be null.

flags int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES