MutableDictionary (Couchbase Lite 2.0.0-299)

java.lang.Object
- com.couchbase.lite.Dictionary
- - com.couchbase.lite.MutableDictionary

All Implemented Interfaces:

Iterable<String>
```
public final 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

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`contains(String key)`
`int`	`count()`
`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)`
`MutableDictionary`	`remove(String key)` Removes the mapping for a key from this Dictionary
`MutableDictionary`	`setArray(String key, Array value)` Set an Array object for the given key.
`MutableDictionary`	`setBlob(String key, Blob value)` Set a Blob object for the given key.
`MutableDictionary`	`setBoolean(String key, boolean value)` Set a boolean value for the given key.
`MutableDictionary`	`setData(Map<String,Object> data)` Set a dictionary as a content.
`MutableDictionary`	`setDate(String key, Date value)` Set a Date object for the given key.
`MutableDictionary`	`setDictionary(String key, Dictionary value)` Set a Dictionary object for the given key.
`MutableDictionary`	`setDouble(String key, double value)` Set a double value for the given key.
`MutableDictionary`	`setFloat(String key, float value)` Set a float value for the given key.
`MutableDictionary`	`setInt(String key, int value)` Set an int value for the given key.
`MutableDictionary`	`setLong(String key, long value)` Set a long value for the given key.
`MutableDictionary`	`setNumber(String key, Number value)` Set a Number value for the given key.
`MutableDictionary`	`setString(String key, String value)` Set a String value for the given key.
`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, iterator, toMap, toMutable

Methods inherited from class java.lang.Object
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:
    
    The self object.
  - 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:
    
    The self object.
  - setString
```
public MutableDictionary setString(String key,
                                   String value)
```
    Set a String value for the given key.
    
    Parameters:
    
    key - The key
    
    value - The String value.
    
    Returns:
    
    The self object.
  - setNumber
```
public MutableDictionary setNumber(String key,
                                   Number value)
```
    Set a Number value for the given key.
    
    Parameters:
    
    key - The key
    
    value - The number value.
    
    Returns:
    
    The self object.
  - setInt
```
public MutableDictionary setInt(String key,
                                int value)
```
    Set an int value for the given key.
    
    Parameters:
    
    key - The key
    
    value - The int value.
    
    Returns:
    
    The self object.
  - setLong
```
public MutableDictionary setLong(String key,
                                 long value)
```
    Set a long value for the given key.
    
    Parameters:
    
    key - The key
    
    value - The long value.
    
    Returns:
    
    The self object.
  - setFloat
```
public MutableDictionary setFloat(String key,
                                  float value)
```
    Set a float value for the given key.
    
    Parameters:
    
    key - The key
    
    value - The float value.
    
    Returns:
    
    The self object.
  - setDouble
```
public MutableDictionary setDouble(String key,
                                   double value)
```
    Set a double value for the given key.
    
    Parameters:
    
    key - The key
    
    value - The double value.
    
    Returns:
    
    The self object.
  - setBoolean
```
public MutableDictionary setBoolean(String key,
                                    boolean value)
```
    Set a boolean value for the given key.
    
    Parameters:
    
    key - The key
    
    value - The boolean value.
    
    Returns:
    
    The self object.
  - setBlob
```
public MutableDictionary setBlob(String key,
                                 Blob value)
```
    Set a Blob object for the given key.
    
    Parameters:
    
    key - The key
    
    value - The Blob object.
    
    Returns:
    
    The self object.
  - setDate
```
public MutableDictionary setDate(String key,
                                 Date value)
```
    Set a Date object for the given key.
    
    Parameters:
    
    key - The key
    
    value - The Date object.
    
    Returns:
    
    The self object.
  - setArray
```
public MutableDictionary setArray(String key,
                                  Array value)
```
    Set an Array object for the given key.
    
    Parameters:
    
    key - The key
    
    value - The Array object.
    
    Returns:
    
    The self object.
  - setDictionary
```
public MutableDictionary setDictionary(String key,
                                       Dictionary value)
```
    Set a Dictionary object for the given key.
    
    Parameters:
    
    key - The key
    
    value - The Dictionary object.
    
    Returns:
    
    The self object.
  - remove
```
public MutableDictionary remove(String key)
```
    Removes the mapping for a key from this Dictionary
    
    Parameters:
    
    key - the key.
    
    Returns:
    
    The self object.
  - 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.
  - 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)
```

Class MutableDictionary

Constructor Summary

Method Summary

Methods inherited from class com.couchbase.lite.Dictionary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

MutableDictionary

MutableDictionary

Method Detail

setData

setValue

setString

setNumber

setInt

setLong

setFloat

setDouble

setBoolean

setBlob

setDate

setArray

setDictionary

remove

getArray

getDictionary

count

getKeys

getValue

getString

getNumber

getInt

getLong

getFloat

getDouble

getBoolean

getBlob

getDate

toMap

contains