Package com.couchbase.lite

Class Parameters

java.lang.Object
com.couchbase.lite.internal.BaseJFleeceCollection
com.couchbase.lite.Parameters
public class Parameters extends com.couchbase.lite.internal.BaseJFleeceCollection
A Parameters object used for setting values to the query parameters defined in the query.

  • Constructor Details

    • Parameters

      public Parameters()

    • Parameters

      public Parameters(@Nullable Parameters parameters)

  • Method Details

    • getValue

      @Nullable public final Object getValue(@NonNull String name)
      Gets a parameter's value.
      Parameters:
      name - The parameter name.
      Returns:
      The parameter value.

    • getValue

      @Nullable public <T> T getValue(@NonNull Class<T> klass, @NonNull String name)
      Gets a parameter's value.
      Parameters:
      name - the key.
      Returns:
      The value in the dictionary at the key (or null).
      Throws:
      ClassCastException - if the value is not of the passed class.

    • setString

      @NonNull public final Parameters setString(@NonNull String name, @Nullable String value)
      Set an String value to the query parameter referenced by the given name. A query parameter is defined by using the Expression's parameter(String name) function.
      Parameters:
      name - The parameter name.
      value - The String value.
      Returns:
      The self object.

    • setNumber

      @NonNull public final Parameters setNumber(@NonNull String name, @Nullable Number value)
      Set an Number value to the query parameter referenced by the given name. A query parameter is defined by using the Expression's parameter(String name) function.
      Parameters:
      name - The parameter name.
      value - The Number value.
      Returns:
      The self object.

    • setInt

      @NonNull public final Parameters setInt(@NonNull String name, int value)
      Set an int value to the query parameter referenced by the given name. A query parameter is defined by using the Expression's parameter(String name) function.
      Parameters:
      name - The parameter name.
      value - The int value.
      Returns:
      The self object.

    • setLong

      @NonNull public final Parameters setLong(@NonNull String name, long value)
      Set an long value to the query parameter referenced by the given name. A query parameter is defined by using the Expression's parameter(String name) function.
      Parameters:
      name - The parameter name.
      value - The long value.
      Returns:
      The self object.

    • setFloat

      @NonNull public final Parameters setFloat(@NonNull String name, float value)
      Set a float value to the query parameter referenced by the given name. A query parameter is defined by using the Expression's parameter(String name) function.
      Parameters:
      name - The parameter name.
      value - The float value.
      Returns:
      The self object.

    • setDouble

      @NonNull public final Parameters setDouble(@NonNull String name, double value)
      Set a double value to the query parameter referenced by the given name. A query parameter is defined by using the Expression's parameter(String name) function.
      Parameters:
      name - The parameter name.
      value - The double value.
      Returns:
      The self object.

    • setBoolean

      @NonNull public final Parameters setBoolean(@NonNull String name, boolean value)
      Set a boolean value to the query parameter referenced by the given name. A query parameter is defined by using the Expression's parameter(String name) function.
      Parameters:
      name - The parameter name.
      value - The boolean value.
      Returns:
      The self object.

    • setDate

      @NonNull public final Parameters setDate(@NonNull String name, @Nullable Date value)
      Set a date value to the query parameter referenced by the given name. A query parameter is defined by using the Expression's parameter(String name) function.

      Note: The date value is stored as a string in the ISO 8601 format. params.setDate("foo", new Date()).getValue("foo") returns a string in ISO 8601 format, not a Date.

      Parameters:
      name - The parameter name.
      value - The date value.
      Returns:
      The self object.

    • setBlob

      @NonNull public final Parameters setBlob(@NonNull String name, @Nullable Blob value)
      Set the Blob value to the query parameter referenced by the given name. A query parameter is defined by using the Expression's parameter(String name) function.
      Parameters:
      name - The parameter name.
      value - The Blob value.
      Returns:
      The self object.

    • setArray

      @NonNull public final Parameters setArray(@NonNull String name, @Nullable Array value)
      Set the Array value to the query parameter referenced by the given name. A query parameter is defined by using the Expression's parameter(String name) function.

      Note: The Array is not copied before insertion into the Parameters object: changes to the Array after it is set in the Array but before the Parameters are attached to a Query, will be reflected in the Query. Changes to the Dictionary after the Parameters are attached to a Query will not be reflected in the Query and will leave the Parameters in an inconsistent state.

      Parameters:
      name - The parameter name.
      value - The Array value.
      Returns:
      The self object.

    • setDictionary

      @NonNull public final Parameters setDictionary(@NonNull String name, @Nullable Dictionary value)
      Set the Dictionary value to the query parameter referenced by the given name. A query parameter is defined by using the Expression's parameter(String name) function.

      Note: The Dictionary is not copied before insertion into the Parameters object: changes to the Dictionary after it is set in the Array but before the Parameters are attached to a Query, will be reflected in the Query. Changes to the Dictionary after the Parameters are attached to a Query will not be reflected in the Query and will leave the Parameters in an inconsistent state.

      Parameters:
      name - The parameter name.
      value - The Dictionary value.
      Returns:
      The self object.

    • setValue

      @NonNull public Parameters setValue(@NonNull String name, @Nullable Object value)
      Set a value to the query parameter referenced by the given name. A query parameter is defined by using the Expression's parameter(String name) function.
      Parameters:
      name - The parameter name.
      value - The value.
      Returns:
      The self object.