Package com.couchbase.lite

Class Result

java.lang.Object
com.couchbase.lite.internal.BaseJFleeceCollection
com.couchbase.lite.Result
All Implemented Interfaces:
ArrayInterface, DictionaryInterface, com.couchbase.lite.internal.fleece.JSONEncodable, JFleeceCollectionInterface, Iterable<String>
public final class Result extends com.couchbase.lite.internal.BaseJFleeceCollection implements ArrayInterface, DictionaryInterface, com.couchbase.lite.internal.fleece.JSONEncodable, Iterable<String>
Result represents a row of result set returned by a Query.

A Result may be referenced only while the ResultSet that contains it is open. An attempt to reference a Result after calling ResultSet.close on the ResultSet that contains it will throw an CouchbaseLiteError

  • Method Summary

    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 Array
    Blob
    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 Blob
    boolean
    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 false if the key doesn't exist or if the value is not a boolean
    Date
    getDate(int index)
    Gets value at the given index 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 Date
    Dictionary
    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 Dictionary
    double
    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 double
    float
    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 float
    int
    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 int
    List<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 long
    Number
    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 Number
    String
    getString(int index)
    The result at the given index converted to a String
    String
    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.
    <T> T
    getValue(Class<T> klass, int index)
    The result value at the given index.
    <T> T
    getValue(Class<T> klass, String key)
    Gets a property's value as an object.
    Object
    getValue(String key)
    The result value for the given key as an Object Returns null if the key doesn't exist.
    boolean
    isEmpty()
     
    Iterator<String>
    iterator()
    Gets an iterator over the result's keys.
    String
    toJSON()
    Encode a Result as a JSON string
    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

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

  • Method Details

    • count

      public int count()
      Specified by:
      count in interface JFleeceCollectionInterface
      Returns:
      the number of the values in the result.

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface JFleeceCollectionInterface

    • 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 interface ArrayInterface
      Parameters:
      index - the index of the required value.
      Returns:
      a boolean 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 interface ArrayInterface
      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 interface ArrayInterface
      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 interface ArrayInterface
      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 interface ArrayInterface
      Parameters:
      index - the index of the required value.
      Returns:
      a double 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 interface ArrayInterface
      Parameters:
      index - the index of the required value.
      Returns:
      a Number value.

    • getString

      @Nullable public String getString(int index)
      The result at the given index converted to a String
      Specified by:
      getString in interface ArrayInterface
      Parameters:
      index - the index of the required value.
      Returns:
      a String value.

    • getDate

      @Nullable public Date getDate(int index)
      Gets value at the given index as a Date. JSON does not directly support dates, so the actual property value must be a string, which is then parsed according to the ISO-8601 date format (the default used in JSON.) Returns null if the value doesn't exist, is not a string, or is not parsable as a date. NOTE: This is not a generic date parser! It only recognizes the ISO-8601 format, with or without milliseconds.
      Specified by:
      getDate in interface ArrayInterface
      Parameters:
      index - the index. This value must not exceed the bounds of the array.
      Returns:
      the Date value or null.

    • 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 interface ArrayInterface
      Parameters:
      index - the index of the required value.
      Returns:
      a Blob.

    • 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 interface ArrayInterface
      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 interface ArrayInterface
      Parameters:
      index - the index of the required value.
      Returns:
      a Dictionary.

    • getValue

      @Nullable public Object getValue(int index)
      The result value at the given index.
      Specified by:
      getValue in interface ArrayInterface
      Parameters:
      index - the index of the required value.
      Returns:
      the value.

    • getValue

      @Nullable public <T> T getValue(@NonNull Class<T> klass, int index)
      The result value at the given index.
      Specified by:
      getValue in interface ArrayInterface
      Parameters:
      index - the index. This value must be 0 <= index < count().
      klass - the class of the object.
      Returns:
      the array value at the index.

    • 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 interface ArrayInterface
      Returns:
      a List containing all values.

    • contains

      public boolean contains(@NonNull String key)
      Tests whether key exists or not.
      Specified by:
      contains in interface DictionaryInterface
      Parameters:
      key - The select result key.
      Returns:
      True if exists, otherwise false.

    • getKeys

      @NonNull public List<String> getKeys()
      Specified by:
      getKeys in interface DictionaryInterface
      Returns:
      a list of keys

    • getBoolean

      public boolean getBoolean(@NonNull String key)
      The result value for the given key as a boolean Returns false if the key doesn't exist or if the value is not a boolean
      Specified by:
      getBoolean in interface DictionaryInterface
      Parameters:
      key - The select result key.
      Returns:
      The boolean value.

    • 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 interface DictionaryInterface
      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 interface DictionaryInterface
      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 interface DictionaryInterface
      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 interface DictionaryInterface
      Parameters:
      key - The select result key.
      Returns:
      The double value.

    • 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 interface DictionaryInterface
      Parameters:
      key - The select result key.
      Returns:
      The Number 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 interface DictionaryInterface
      Parameters:
      key - The select result key.
      Returns:
      The String 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 interface DictionaryInterface
      Parameters:
      key - The select result key.
      Returns:
      The Date object.

    • 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 interface DictionaryInterface
      Parameters:
      key - The select result key.
      Returns:
      The Blob 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 interface DictionaryInterface
      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 interface DictionaryInterface
      Parameters:
      key - The select result key.
      Returns:
      The Dictionary object.

    • 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 interface DictionaryInterface
      Parameters:
      key - The select result key.
      Returns:
      The Object.

    • getValue

      @Nullable public <T> T getValue(@NonNull Class<T> klass, @NonNull String key)
      Gets a property's value as an object. The object types are Blob, Array, Dictionary, Number, or String based on the underlying data type; or nil if the property value is null or the property doesn't exist.
      Specified by:
      getValue in interface DictionaryInterface
      Parameters:
      key - the key.
      Returns:
      The value in the dictionary at the key (or null).
      Throws:
      ClassCastException - if the value is not of the passed class.

    • 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 interface DictionaryInterface
      Returns:
      The Map representing all values.

    • toJSON

      @NonNull public String toJSON() throws CouchbaseLiteException
      Encode a Result as a JSON string
      Specified by:
      toJSON in interface com.couchbase.lite.internal.fleece.JSONEncodable
      Returns:
      JSON encoded representation of the Result
      Throws:
      CouchbaseLiteException - on encoder failure.

    • iterator

      @NonNull public Iterator<String> iterator()
      Gets an iterator over the result's keys.
      Specified by:
      iterator in interface Iterable<String>
      Returns:
      The Iterator object of all result keys.