Package com.couchbase.lite

Class Result

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean contains​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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
      java.util.Date getDate​(int index)
      The result at the given index interpreted as a Date.
      java.util.Date getDate​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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
      java.util.List<java.lang.String> getKeys()  
      long getLong​(int index)
      The result at the given index interpreted as a long.
      long getLong​(java.lang.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
      java.lang.Number getNumber​(int index)
      The result at the given index interpreted as a Number.
      java.lang.Number getNumber​(java.lang.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
      java.lang.String getString​(int index)
      The result at the given index converted to a String
      java.lang.String getString​(java.lang.String key)
      The result value for the given key as a String Returns null if the key doesn't exist.
      java.lang.Object getValue​(int index)
      The result value at the given index.
      java.lang.Object getValue​(java.lang.String key)
      The result value for the given key as an Object Returns null if the key doesn't exist.
      java.util.Iterator<java.lang.String> iterator()
      Gets an iterator over the result's keys.
      java.lang.String toJSON()  
      java.util.List<java.lang.Object> toList()
      Gets all the values as a List.
      java.util.Map<java.lang.String,​java.lang.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 Detail

      • getValue

        @Nullable
public java.lang.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.

      • getString

        @Nullable
public java.lang.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.

      • getNumber

        @Nullable
public java.lang.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.

      • 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.

      • 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.

      • 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.

      • getDate

        @Nullable
public java.util.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 interface ArrayInterface
        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 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.

      • toList

        @NonNull
public java.util.List<java.lang.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.

      • getKeys

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

      • getValue

        @Nullable
public java.lang.Object getValue​(@NonNull
                                 java.lang.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.

      • getString

        @Nullable
public java.lang.String getString​(@NonNull
                                  java.lang.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.

      • getNumber

        @Nullable
public java.lang.Number getNumber​(@NonNull
                                  java.lang.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.

      • getInt

        public int getInt​(@NonNull
                  java.lang.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
                    java.lang.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
                      java.lang.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
                        java.lang.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.

      • getBoolean

        public boolean getBoolean​(@NonNull
                          java.lang.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 interface DictionaryInterface
        Parameters:
        key - The select result key.
        Returns:
        The boolean value.

      • getBlob

        @Nullable
public Blob getBlob​(@NonNull
                    java.lang.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.

      • getDate

        @Nullable
public java.util.Date getDate​(@NonNull
                              java.lang.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.

      • getArray

        @Nullable
public Array getArray​(@NonNull
                      java.lang.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
                                java.lang.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.

      • toMap

        @NonNull
public java.util.Map<java.lang.String,​java.lang.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.

      • contains

        public boolean contains​(@NonNull
                        java.lang.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.

      • iterator

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