Package com.yandex.ydb.table.query

Interface Params

@ParametersAreNonnullByDefault
public interface Params

Author:

Sergey Polovko

Method Summary

Modifier and Type	Method	Description
static Params	copyOf(Params params)	Returns a mutable implementation of Params containing the same entries as given parameters.
static Params	copyOf(Map<String,Value<?>> values)	Returns a mutable implementation of Params containing the same entries as given map.
static Params	create()	Returns a modifiable implementation of Params with no parameters.
static Params	create(int initialCapacity)	Returns a modifiable implementation of Params with no parameters.
static Params	empty()	Returns an immutable implementation of Params with no parameters.
boolean	isEmpty()	Returns true if there are no defined parameters in this container.
static Params	of(String name, Value<?> value)	Returns an immutable implementation of Params with single parameter.
static Params	of(String name1, Value<?> value1, String name2, Value<?> value2)	Returns an immutable implementation of Params with two parameters.
static Params	of(String name1, Value<?> value1, String name2, Value<?> value2, String name3, Value<?> value3)	Returns an immutable implementation of Params with three parameters.
static Params	of(String name1, Value<?> value1, String name2, Value<?> value2, String name3, Value<?> value3, String name4, Value<?> value4)	Returns an immutable implementation of Params with four parameters.
static Params	of(String name1, Value<?> value1, String name2, Value<?> value2, String name3, Value<?> value3, String name4, Value<?> value4, String name5, Value<?> value5)	Returns an immutable implementation of Params with five parameters.
static Params	of(String name1, Value<?> value1, String name2, Value<?> value2, String name3, Value<?> value3, String name4, Value<?> value4, String name5, Value<?> value5, String name6, Value<?> value6)	Returns an immutable implementation of Params with six parameters.
static Params	of(String name1, Value<?> value1, String name2, Value<?> value2, String name3, Value<?> value3, String name4, Value<?> value4, String name5, Value<?> value5, String name6, Value<?> value6, String name7, Value<?> value7, String name8, Value<?> value8)	Returns an immutable implementation of Params with eight parameters.
static Params	of(String name1, Value<?> value1, String name2, Value<?> value2, String name3, Value<?> value3, String name4, Value<?> value4, String name5, Value<?> value5, String name6, Value<?> value6, String name7, Value<?> value7, String name8, Value<?> value8, String name9, Value<?> value9)	Returns an immutable implementation of Params with nine parameters.
<T extends Type> Params	put(String name, Value<T> value)	Associates the specified value with the specified name in this params container.
Map<String,com.yandex.ydb.ValueProtos.TypedValue>	toPb()	Converts each parameter value into Protobuf message ValueProtos.TypedValue and return them as unmodifiable map.
Map<String,Value<?>>	values()	Returns original values as unmodifiable map.

Method Detail

empty

static Params empty()

Returns an immutable implementation of Params with no parameters.

Returns:

an empty Params

create

static Params create()

Returns a modifiable implementation of Params with no parameters.

Returns:

an empty Params

create

static Params create(int initialCapacity)

Returns a modifiable implementation of Params with no parameters.

Parameters:

initialCapacity - initial capacity of backing map

Returns:

an empty Params

of

static Params of(String name,
                 Value<?> value)

Returns an immutable implementation of Params with single parameter.

Returns:

non empty Params with single parameter

of

static Params of(String name1,
                 Value<?> value1,
                 String name2,
                 Value<?> value2)

Returns an immutable implementation of Params with two parameters.

Returns:

non empty Params with two parameters

of

static Params of(String name1,
                 Value<?> value1,
                 String name2,
                 Value<?> value2,
                 String name3,
                 Value<?> value3)

Returns an immutable implementation of Params with three parameters.

Returns:

non empty Params with three parameters

of

static Params of(String name1,
                 Value<?> value1,
                 String name2,
                 Value<?> value2,
                 String name3,
                 Value<?> value3,
                 String name4,
                 Value<?> value4)

Returns an immutable implementation of Params with four parameters.

Returns:

non empty Params with four parameters

of

static Params of(String name1,
                 Value<?> value1,
                 String name2,
                 Value<?> value2,
                 String name3,
                 Value<?> value3,
                 String name4,
                 Value<?> value4,
                 String name5,
                 Value<?> value5)

Returns an immutable implementation of Params with five parameters.

Returns:

non empty Params with five parameters

of

static Params of(String name1,
                 Value<?> value1,
                 String name2,
                 Value<?> value2,
                 String name3,
                 Value<?> value3,
                 String name4,
                 Value<?> value4,
                 String name5,
                 Value<?> value5,
                 String name6,
                 Value<?> value6)

Returns an immutable implementation of Params with six parameters.

Returns:

non empty Params with six parameters

of

static Params of(String name1,
                 Value<?> value1,
                 String name2,
                 Value<?> value2,
                 String name3,
                 Value<?> value3,
                 String name4,
                 Value<?> value4,
                 String name5,
                 Value<?> value5,
                 String name6,
                 Value<?> value6,
                 String name7,
                 Value<?> value7,
                 String name8,
                 Value<?> value8)

Returns an immutable implementation of Params with eight parameters.

Returns:

non empty Params with eight parameters

of

static Params of(String name1,
                 Value<?> value1,
                 String name2,
                 Value<?> value2,
                 String name3,
                 Value<?> value3,
                 String name4,
                 Value<?> value4,
                 String name5,
                 Value<?> value5,
                 String name6,
                 Value<?> value6,
                 String name7,
                 Value<?> value7,
                 String name8,
                 Value<?> value8,
                 String name9,
                 Value<?> value9)

Returns an immutable implementation of Params with nine parameters.

Returns:

non empty Params with nine parameters

copyOf

static Params copyOf(Map<String,Value<?>> values)

Returns a mutable implementation of Params containing the same entries as given map.

Parameters:

values - entries to be copied

Returns:

Params containing specified values

copyOf

static Params copyOf(Params params)

Returns a mutable implementation of Params containing the same entries as given parameters.

Parameters:

params - parameters to be copied

Returns:

Params containing specified parameters

isEmpty

boolean isEmpty()

Returns true if there are no defined parameters in this container.

Returns:

true if there are no defined parameters in this container.

put

<T extends Type> Params put(String name,
                            Value<T> value)

Associates the specified value with the specified name in this params container.

Parameters:

name - name with which the specified value is to be associated

value - value to be associated with the specified name

Returns:

this params container

toPb

Map<String,com.yandex.ydb.ValueProtos.TypedValue> toPb()

Converts each parameter value into Protobuf message ValueProtos.TypedValue and return them as unmodifiable map.

Returns:

map of converted parameters

values

Map<String,Value<?>> values()

Returns original values as unmodifiable map.

Returns:

unmodifiable map of values