Package com.couchbase.lite

Class Parameters

java.lang.Object

com.couchbase.lite.Parameters

public final class Parameters
extends 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

Modifier and Type	Method	Description
Object	getValue(String name)	Gets a parameter's value.
Parameters	setArray(String name, Array value)	Set the Array value to the query parameter referenced by the given name.
Parameters	setBlob(String name, Blob value)	Set the Blob value to the query parameter referenced by the given name.
Parameters	setBoolean(String name, boolean value)	Set a boolean value to the query parameter referenced by the given name.
Parameters	setDate(String name, Date value)	Set a date value to the query parameter referenced by the given name.
Parameters	setDictionary(String name, Dictionary value)	Set the Dictionary value to the query parameter referenced by the given name.
Parameters	setDouble(String name, double value)	Set a double value to the query parameter referenced by the given name.
Parameters	setFloat(String name, float value)	Set a float value to the query parameter referenced by the given name.
Parameters	setInt(String name, int value)	Set an int value to the query parameter referenced by the given name.
Parameters	setLong(String name, long value)	Set an long value to the query parameter referenced by the given name.
Parameters	setNumber(String name, Number value)	Set an Number value to the query parameter referenced by the given name.
Parameters	setString(String name, String value)	Set an String value to the query parameter referenced by the given name.
Parameters	setValue(String name, Object value)	Set a value to the query parameter referenced by the given name.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameters

public Parameters()

Parameters

public Parameters(@Nullable
                  Parameters parameters)

Method Detail

getValue

@Nullable
public Object getValue(@NonNull
                       String name)

Gets a parameter's value.

Parameters:

name - The parameter name.

Returns:

The parameter value.

setString

@NonNull
public 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 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 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 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 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 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 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 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.

Parameters:

name - The parameter name.

value - The date value.

Returns:

The self object.

setBlob

@NonNull
public 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.

setDictionary

@NonNull
public 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.

Parameters:

name - The parameter name.

value - The Dictionary value.

Returns:

The self object.

setArray

@NonNull
public 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.

Parameters:

name - The parameter name.

value - The Array 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.