Package com.couchbase.lite
Class Parameters
- java.lang.Object
-
- com.couchbase.lite.Parameters
-
public final class Parameters extends java.lang.Object
A Parameters object used for setting values to the query parameters defined in the query.
-
-
Constructor Summary
Constructors Constructor Description Parameters()
Parameters(Parameters parameters)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
getValue(java.lang.String name)
Gets a parameter's value.Parameters
setArray(java.lang.String name, Array value)
Set the Array value to the query parameter referenced by the given name.Parameters
setBlob(java.lang.String name, Blob value)
Set the Blob value to the query parameter referenced by the given name.Parameters
setBoolean(java.lang.String name, boolean value)
Set a boolean value to the query parameter referenced by the given name.Parameters
setDate(java.lang.String name, java.util.Date value)
Set a date value to the query parameter referenced by the given name.Parameters
setDictionary(java.lang.String name, Dictionary value)
Set the Dictionary value to the query parameter referenced by the given name.Parameters
setDouble(java.lang.String name, double value)
Set a double value to the query parameter referenced by the given name.Parameters
setFloat(java.lang.String name, float value)
Set a float value to the query parameter referenced by the given name.Parameters
setInt(java.lang.String name, int value)
Set an int value to the query parameter referenced by the given name.Parameters
setLong(java.lang.String name, long value)
Set an long value to the query parameter referenced by the given name.Parameters
setNumber(java.lang.String name, java.lang.Number value)
Set an Number value to the query parameter referenced by the given name.Parameters
setString(java.lang.String name, java.lang.String value)
Set an String value to the query parameter referenced by the given name.Parameters
setValue(java.lang.String name, java.lang.Object value)
Set a value to the query parameter referenced by the given name.
-
-
-
Constructor Detail
-
Parameters
public Parameters()
-
Parameters
public Parameters(@Nullable Parameters parameters)
-
-
Method Detail
-
getValue
@Nullable public java.lang.Object getValue(@NonNull java.lang.String name)
Gets a parameter's value.- Parameters:
name
- The parameter name.- Returns:
- The parameter value.
-
setString
@NonNull public Parameters setString(@NonNull java.lang.String name, @Nullable java.lang.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 Parameters setNumber(@NonNull java.lang.String name, @Nullable java.lang.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 Parameters setInt(@NonNull java.lang.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 Parameters setLong(@NonNull java.lang.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 Parameters setFloat(@NonNull java.lang.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 Parameters setDouble(@NonNull java.lang.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 Parameters setBoolean(@NonNull java.lang.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 Parameters setDate(@NonNull java.lang.String name, @Nullable java.util.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.- Parameters:
name
- The parameter name.value
- The date value.- Returns:
- The self object.
-
setBlob
@NonNull public Parameters setBlob(@NonNull java.lang.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.
-
setDictionary
@NonNull public Parameters setDictionary(@NonNull java.lang.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.- Parameters:
name
- The parameter name.value
- The Dictionary value.- Returns:
- The self object.
-
setArray
@NonNull public Parameters setArray(@NonNull java.lang.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.- Parameters:
name
- The parameter name.value
- The Array value.- Returns:
- The self object.
-
setValue
@NonNull public Parameters setValue(@NonNull java.lang.String name, @Nullable java.lang.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.
-
-