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 and Description
Parameters()
Parameters(Parameters parameters)

Method Summary

Modifier and Type	Method and Description
Object	getValue(String name) Gets a parameter's value.
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	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(Parameters parameters)

Method Detail

setValue

public Parameters setValue(String name,
                           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.

setString

public Parameters setString(String name,
                            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

public Parameters setNumber(String name,
                            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

public Parameters setInt(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

public Parameters setLong(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

public Parameters setFloat(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

public Parameters setDouble(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

public Parameters setBoolean(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

public Parameters setDate(String name,
                          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(_ name: String) function.

Parameters:

name - The parameter name.

value - The date value.

Returns:

The self object.

getValue

public Object getValue(String name)

Gets a parameter's value.

Parameters:

name - The parameter name.

Returns:

The parameter value.