Package com.couchbase.lite
Class Result
- java.lang.Object
-
- com.couchbase.lite.Result
-
- All Implemented Interfaces:
ArrayInterface
,DictionaryInterface
,Iterable<String>
public final class Result extends Object implements ArrayInterface, DictionaryInterface, Iterable<String>
Result represents a row of result set returned by a Query.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
contains(String key)
Tests whether key exists or not.int
count()
Array
getArray(int index)
The result at the given index interpreted as an Array.Array
getArray(String key)
The result value for the given key as a Array Returns null if the key doesn't exist or if the value is not an ArrayBlob
getBlob(int index)
The result at the given index interpreted as a Blob.Blob
getBlob(String key)
The result value for the given key as a Blob Returns null if the key doesn't exist or if the value is not a Blobboolean
getBoolean(int index)
The result at the given index interpreted as a boolean.boolean
getBoolean(String key)
The result value for the given key as a boolean Returns null if the key doesn't exist or if the value is not a booleanDate
getDate(int index)
The result at the given index interpreted as a Date.Date
getDate(String key)
The result value for the given key as a Date Returns null if the key doesn't exist or if the value is not a DateDictionary
getDictionary(int index)
The result at the given index interpreted as a Dictionary.Dictionary
getDictionary(String key)
The result value for the given key as a Dictionary Returns null if the key doesn't exist or if the value is not a Dictionarydouble
getDouble(int index)
The result at the given index interpreted as a double.double
getDouble(String key)
The result value for the given key as a double Returns 0.0 if the key doesn't exist or if the value is not a doublefloat
getFloat(int index)
The result at the given index interpreted as a float.float
getFloat(String key)
The result value for the given key as a float Returns 0.0F if the key doesn't exist or if the value is not a floatint
getInt(int index)
The result at the given index interpreted as and an int.int
getInt(String key)
The result value for the given key as an int Returns 0 if the key doesn't exist or if the value is not a intList<String>
getKeys()
long
getLong(int index)
The result at the given index interpreted as a long.long
getLong(String key)
The result value for the given key as a long Returns 0L if the key doesn't exist or if the value is not a longNumber
getNumber(int index)
The result at the given index interpreted as a Number.Number
getNumber(String key)
The result value for the given key as a Number Returns null if the key doesn't exist or if the value is not a NumberString
getString(int index)
The result at the given index converted to a StringString
getString(String key)
The result value for the given key as a String Returns null if the key doesn't exist.Object
getValue(int index)
The result value at the given index.Object
getValue(String key)
The result value for the given key as an Object Returns null if the key doesn't exist.Iterator<String>
iterator()
Gets an iterator over the result's keys.String
toJSON()
List<Object>
toList()
Gets all the values as a List.Map<String,Object>
toMap()
Gets all values as a Map.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Method Detail
-
count
public int count()
- Specified by:
count
in interfaceArrayInterface
- Specified by:
count
in interfaceDictionaryInterface
- Returns:
- the number of the values in the result.
-
getValue
@Nullable public Object getValue(int index)
The result value at the given index.- Specified by:
getValue
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- the value.
-
getString
@Nullable public String getString(int index)
The result at the given index converted to a String- Specified by:
getString
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a String value.
-
getNumber
@Nullable public Number getNumber(int index)
The result at the given index interpreted as a Number. Returns null if the value cannot be so interpreted.- Specified by:
getNumber
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a Number value.
-
getInt
public int getInt(int index)
The result at the given index interpreted as and an int. Returns 0 if the value cannot be so interpreted.- Specified by:
getInt
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- an int value.
-
getLong
public long getLong(int index)
The result at the given index interpreted as a long. Returns 0 if the value cannot be so interpreted.- Specified by:
getLong
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a long value.
-
getFloat
public float getFloat(int index)
The result at the given index interpreted as a float. Returns 0.0F if the value cannot be so interpreted.- Specified by:
getFloat
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a float value.
-
getDouble
public double getDouble(int index)
The result at the given index interpreted as a double. Returns 0.0 if the value cannot be so interpreted.- Specified by:
getDouble
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a double value.
-
getBoolean
public boolean getBoolean(int index)
The result at the given index interpreted as a boolean. Returns false if the value cannot be so interpreted.- Specified by:
getBoolean
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a boolean value.
-
getBlob
@Nullable public Blob getBlob(int index)
The result at the given index interpreted as a Blob. Returns null if the value cannot be so interpreted.- Specified by:
getBlob
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a Blob.
-
getDate
@Nullable public Date getDate(int index)
The result at the given index interpreted as a Date. Returns null if the value cannot be so interpreted.- Specified by:
getDate
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a Date.
-
getArray
@Nullable public Array getArray(int index)
The result at the given index interpreted as an Array. Returns null if the value cannot be so interpreted.- Specified by:
getArray
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- an Array.
-
getDictionary
@Nullable public Dictionary getDictionary(int index)
The result at the given index interpreted as a Dictionary. Returns null if the value cannot be so interpreted.- Specified by:
getDictionary
in interfaceArrayInterface
- Parameters:
index
- the index of the required value.- Returns:
- a Dictionary.
-
toList
@NonNull public List<Object> toList()
Gets all the values as a List. The types of the values contained in the returned List are Array, Blob, Dictionary, Number types, String, and null.- Specified by:
toList
in interfaceArrayInterface
- Returns:
- a List containing all values.
-
getKeys
@NonNull public List<String> getKeys()
- Specified by:
getKeys
in interfaceDictionaryInterface
- Returns:
- a list of keys
-
getValue
@Nullable public Object getValue(@NonNull String key)
The result value for the given key as an Object Returns null if the key doesn't exist.- Specified by:
getValue
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The Object.
-
getString
@Nullable public String getString(@NonNull String key)
The result value for the given key as a String Returns null if the key doesn't exist.- Specified by:
getString
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The String object.
-
getNumber
@Nullable public Number getNumber(@NonNull String key)
The result value for the given key as a Number Returns null if the key doesn't exist or if the value is not a Number- Specified by:
getNumber
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The Number object.
-
getInt
public int getInt(@NonNull String key)
The result value for the given key as an int Returns 0 if the key doesn't exist or if the value is not a int- Specified by:
getInt
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The integer value.
-
getLong
public long getLong(@NonNull String key)
The result value for the given key as a long Returns 0L if the key doesn't exist or if the value is not a long- Specified by:
getLong
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The long value.
-
getFloat
public float getFloat(@NonNull String key)
The result value for the given key as a float Returns 0.0F if the key doesn't exist or if the value is not a float- Specified by:
getFloat
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The float value.
-
getDouble
public double getDouble(@NonNull String key)
The result value for the given key as a double Returns 0.0 if the key doesn't exist or if the value is not a double- Specified by:
getDouble
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The double value.
-
getBoolean
public boolean getBoolean(@NonNull String key)
The result value for the given key as a boolean Returns null if the key doesn't exist or if the value is not a boolean- Specified by:
getBoolean
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The boolean value.
-
getBlob
@Nullable public Blob getBlob(@NonNull String key)
The result value for the given key as a Blob Returns null if the key doesn't exist or if the value is not a Blob- Specified by:
getBlob
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The Blob object.
-
getDate
@Nullable public Date getDate(@NonNull String key)
The result value for the given key as a Date Returns null if the key doesn't exist or if the value is not a Date- Specified by:
getDate
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The Date object.
-
getArray
@Nullable public Array getArray(@NonNull String key)
The result value for the given key as a Array Returns null if the key doesn't exist or if the value is not an Array- Specified by:
getArray
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The Array object.
-
getDictionary
@Nullable public Dictionary getDictionary(@NonNull String key)
The result value for the given key as a Dictionary Returns null if the key doesn't exist or if the value is not a Dictionary- Specified by:
getDictionary
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- The Dictionary object.
-
toMap
@NonNull public Map<String,Object> toMap()
Gets all values as a Map. The keys in the returned map are the names of columns that have values. The types of the values are Array, Blob, Dictionary, Number types, String, and null.- Specified by:
toMap
in interfaceDictionaryInterface
- Returns:
- The Map representing all values.
-
toJSON
@NonNull public String toJSON()
- Specified by:
toJSON
in interfaceArrayInterface
- Specified by:
toJSON
in interfaceDictionaryInterface
-
contains
public boolean contains(@NonNull String key)
Tests whether key exists or not.- Specified by:
contains
in interfaceDictionaryInterface
- Parameters:
key
- The select result key.- Returns:
- True if exists, otherwise false.
-
-