com.couchbase.lite

Class MutableDictionary

java.lang.Object

com.couchbase.lite.Dictionary

com.couchbase.lite.MutableDictionary

All Implemented Interfaces:

DictionaryInterface, FLEncodable, MutableDictionaryInterface, Iterable<String>

public final class MutableDictionary
extends Dictionary
implements MutableDictionaryInterface

Dictionary provides access to dictionary data.

Constructor Summary

Constructors

Constructor and Description
MutableDictionary() Initialize a new empty Dictionary object.
MutableDictionary(Map<String,Object> data) Creates a new MutableDictionary with content from the passed Map.
MutableDictionary(String json) Creates a new MutableDictionary with content from the passed JSON string.

Method Summary

Modifier and Type	Method and Description
MutableArray	getArray(String key) Get a property's value as a Array, which is a mapping object of an array value.
MutableDictionary	getDictionary(String key) Get a property's value as a Dictionary, which is a mapping object of an dictionary value.
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) Populate a dictionary with content from a Map.
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	setJSON(String json) Populate a dictionary with content from a JSON string.
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.
String	toJSON()

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, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.couchbase.lite.DictionaryInterface

contains, count, getBlob, getBoolean, getDate, getDouble, getFloat, getInt, getKeys, getLong, getNumber, getString, getValue, toMap

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MutableDictionary

public MutableDictionary()

Initialize a new empty Dictionary object.

MutableDictionary

public MutableDictionary(@NonNull
                         Map<String,Object> data)

Creates a new MutableDictionary with content from the passed Map. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Maps and Dictionaries may contain only the above types.

Parameters:

data - the dictionary content map.

MutableDictionary

public MutableDictionary(@NonNull
                         String json)

Creates a new MutableDictionary with content from the passed JSON string.

Parameters:

json - the dictionary content as a JSON string.

Method Detail

setData

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

Populate a dictionary with content from a Map. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Maps and Dictionaries may contain only the above types. Setting the dictionary content will replace the current data including any existing Array and Dictionary objects.

Specified by:

setData in interface MutableDictionaryInterface

Parameters:

data - the dictionary object.

Returns:

The self object.

setJSON

@NonNull
public MutableDictionary setJSON(@NonNull
                                          String json)

Populate a dictionary with content from a JSON string. Setting the dictionary content will replace the current data including any existing Array and Dictionary objects.

Specified by:

setJSON in interface MutableDictionaryInterface

Parameters:

json - the dictionary object.

Returns:

this Document instance

setValue

@NonNull
public MutableDictionary setValue(@NonNull
                                           String key,
                                           @Nullable
                                           Object value)

Set an object value by key. Allowed value types are List, Date, Map, Number, null, String, Array, Blob, and Dictionary. If present, Lists, Maps and Dictionaries may contain only the above types.

Specified by:

setValue in interface MutableDictionaryInterface

Parameters:

key - the key.

value - the object value.

Returns:

The self object.

setString

@NonNull
public MutableDictionary setString(@NonNull
                                            String key,
                                            @Nullable
                                            String value)

Set a String value for the given key.

Specified by:

setString in interface MutableDictionaryInterface

Parameters:

key - The key

value - The String value.

Returns:

The self object.

setNumber

@NonNull
public MutableDictionary setNumber(@NonNull
                                            String key,
                                            @Nullable
                                            Number value)

Set a Number value for the given key.

Specified by:

setNumber in interface MutableDictionaryInterface

Parameters:

key - The key

value - The number value.

Returns:

The self object.

setInt

@NonNull
public MutableDictionary setInt(@NonNull
                                         String key,
                                         int value)

Set an int value for the given key.

Specified by:

setInt in interface MutableDictionaryInterface

Parameters:

key - The key

value - The int value.

Returns:

The self object.

setLong

@NonNull
public MutableDictionary setLong(@NonNull
                                          String key,
                                          long value)

Set a long value for the given key.

Specified by:

setLong in interface MutableDictionaryInterface

Parameters:

key - The key

value - The long value.

Returns:

The self object.

setFloat

@NonNull
public MutableDictionary setFloat(@NonNull
                                           String key,
                                           float value)

Set a float value for the given key.

Specified by:

setFloat in interface MutableDictionaryInterface

Parameters:

key - The key

value - The float value.

Returns:

The self object.

setDouble

@NonNull
public MutableDictionary setDouble(@NonNull
                                            String key,
                                            double value)

Set a double value for the given key.

Specified by:

setDouble in interface MutableDictionaryInterface

Parameters:

key - The key

value - The double value.

Returns:

The self object.

setBoolean

@NonNull
public MutableDictionary setBoolean(@NonNull
                                             String key,
                                             boolean value)

Set a boolean value for the given key.

Specified by:

setBoolean in interface MutableDictionaryInterface

Parameters:

key - The key

value - The boolean value.

Returns:

The self object.

setBlob

@NonNull
public MutableDictionary setBlob(@NonNull
                                          String key,
                                          @NonNull
                                          Blob value)

Set a Blob object for the given key.

Specified by:

setBlob in interface MutableDictionaryInterface

Parameters:

key - The key

value - The Blob object.

Returns:

The self object.

setDate

@NonNull
public MutableDictionary setDate(@NonNull
                                          String key,
                                          @NonNull
                                          Date value)

Set a Date object for the given key.

Specified by:

setDate in interface MutableDictionaryInterface

Parameters:

key - The key

value - The Date object.

Returns:

The self object.

setArray

@NonNull
public MutableDictionary setArray(@NonNull
                                           String key,
                                           @NonNull
                                           Array value)

Set an Array object for the given key.

Specified by:

setArray in interface MutableDictionaryInterface

Parameters:

key - The key

value - The Array object.

Returns:

The self object.

setDictionary

@NonNull
public MutableDictionary setDictionary(@NonNull
                                                String key,
                                                @NonNull
                                                Dictionary value)

Set a Dictionary object for the given key.

Specified by:

setDictionary in interface MutableDictionaryInterface

Parameters:

key - The key

value - The Dictionary object.

Returns:

The self object.

remove

@NonNull
public MutableDictionary remove(@NonNull
                                         String key)

Removes the mapping for a key from this Dictionary

Specified by:

remove in interface MutableDictionaryInterface

Parameters:

key - the key.

Returns:

The self object.

getArray

@Nullable
public MutableArray getArray(@NonNull
                                       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.

Specified by:

getArray in interface DictionaryInterface

Specified by:

getArray in interface MutableDictionaryInterface

Overrides:

getArray in class Dictionary

Parameters:

key - the key.

Returns:

the Array object.

getDictionary

@Nullable
public MutableDictionary getDictionary(@NonNull
                                                 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.

Specified by:

getDictionary in interface DictionaryInterface

Specified by:

getDictionary in interface MutableDictionaryInterface

Overrides:

getDictionary in class Dictionary

Parameters:

key - the key.

Returns:

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

toJSON

@NonNull
public String toJSON()

Specified by:

toJSON in interface DictionaryInterface

Overrides:

toJSON in class Dictionary