com.couchbase.lite

Class MutableDictionary

java.lang.Object

com.couchbase.lite.Dictionary

com.couchbase.lite.MutableDictionary

All Implemented Interfaces:

Iterable<String>

public class MutableDictionary
extends Dictionary

Dictionary provides access to dictionary data.

Constructor Summary

Constructors

Constructor and Description
MutableDictionary() Initialize a new empty Dictionary object.
MutableDictionary(Map<String,Object> data) Initializes a new CBLDictionary object with dictionary content.

Method Summary

Modifier and Type	Method and Description
boolean	contains(String key)
int	count()
protected void	finalize()
MutableArray	getArray(String key) Get a property's value as a Array, which is a mapping object of an array value.
Blob	getBlob(String key)
boolean	getBoolean(String key)
Date	getDate(String key)
MutableDictionary	getDictionary(String key) Get a property's value as a Dictionary, which is a mapping object of an dictionary value.
double	getDouble(String key)
float	getFloat(String key)
int	getInt(String key)
List<String>	getKeys()
long	getLong(String key)
Number	getNumber(String key)
String	getString(String key)
Object	getValue(String key)
protected boolean	isChanged()
MutableDictionary	remove(String key) Removes the mapping for a key from this Dictionary
MutableDictionary	setArray(String key, Array value)
MutableDictionary	setBlob(String key, Blob value)
MutableDictionary	setBoolean(String key, boolean value)
MutableDictionary	setData(Map<String,Object> data) Set a dictionary as a content.
MutableDictionary	setDate(String key, Date value)
MutableDictionary	setDictionary(String key, Dictionary value)
MutableDictionary	setDouble(String key, double value)
MutableDictionary	setFloat(String key, float value)
MutableDictionary	setInt(String key, int value)
MutableDictionary	setLong(String key, long value)
MutableDictionary	setNumber(String key, Number value)
MutableDictionary	setString(String key, String value)
MutableDictionary	setValue(String key, Object value) Set an object value by key.
Map<String,Object>	toMap()

Methods inherited from class com.couchbase.lite.Dictionary

contains, count, encodeTo, equals, getBlob, getBoolean, getDate, getDouble, getFloat, getInt, getKeys, getLong, getNumber, getString, getValue, hashCode, isEmpty, iterator, toMap, toMutable

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MutableDictionary

public MutableDictionary()

Initialize a new empty Dictionary object.

MutableDictionary

public MutableDictionary(Map<String,Object> data)

Initializes a new CBLDictionary object with dictionary content. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. The List and Map must contain only the above types.

Parameters:

data - the dictionary object.

Method Detail

setData

public MutableDictionary setData(Map<String,Object> data)

Set a dictionary as a content. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. The List and Map must contain only the above types. Setting the new dictionary content will replace the current data including the existing Array and Dictionary objects.

Parameters:

data - the dictionary object.

Returns:

this Dictionary instance

setValue

public MutableDictionary setValue(String key,
                                  Object value)

Set an object value by key. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. The List and Map must contain only the above types. An Date object will be converted to an ISO-8601 format string.

Parameters:

key - the key.

value - the object value.

Returns:

this Dictionary instance

setString

public MutableDictionary setString(String key,
                                   String value)

setNumber

public MutableDictionary setNumber(String key,
                                   Number value)

setInt

public MutableDictionary setInt(String key,
                                int value)

setLong

public MutableDictionary setLong(String key,
                                 long value)

setFloat

public MutableDictionary setFloat(String key,
                                  float value)

setDouble

public MutableDictionary setDouble(String key,
                                   double value)

setBoolean

public MutableDictionary setBoolean(String key,
                                    boolean value)

setBlob

public MutableDictionary setBlob(String key,
                                 Blob value)

setDate

public MutableDictionary setDate(String key,
                                 Date value)

setArray

public MutableDictionary setArray(String key,
                                  Array value)

setDictionary

public MutableDictionary setDictionary(String key,
                                       Dictionary value)

remove

public MutableDictionary remove(String key)

Removes the mapping for a key from this Dictionary

Parameters:

key - the key.

Returns:

this Dictionary instance

getArray

public MutableArray getArray(String key)

Get a property's value as a Array, which is a mapping object of an array value. Returns null if the property doesn't exists, or its value is not an array.

Overrides:

getArray in class Dictionary

Parameters:

key - the key.

Returns:

the Array object.

getDictionary

public MutableDictionary getDictionary(String key)

Get a property's value as a Dictionary, which is a mapping object of an dictionary value. Returns null if the property doesn't exists, or its value is not an dictionary.

Overrides:

getDictionary in class Dictionary

Parameters:

key - the key.

Returns:

the Dictionary object or null if the key doesn't exist.

isChanged

protected boolean isChanged()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Dictionary

Throws:

Throwable

count

public int count()

getKeys

public List<String> getKeys()

getValue

public Object getValue(String key)

getString

public String getString(String key)

getNumber

public Number getNumber(String key)

getInt

public int getInt(String key)

getLong

public long getLong(String key)

getFloat

public float getFloat(String key)

getDouble

public double getDouble(String key)

getBoolean

public boolean getBoolean(String key)

getBlob

public Blob getBlob(String key)

getDate

public Date getDate(String key)

toMap

public Map<String,Object> toMap()

contains

public boolean contains(String key)