io.r2dbc.spi

Class Option<T>

java.lang.Object

io.r2dbc.spi.Option<T>

Type Parameters:

T - The value type of the option when configuring a value programmatically

public final class Option<T>
extends Object

Represents a configuration option constant.

Note that Connection URL Parsing cannot access Option type information T due to Java's type erasure. Options configured by URL parsing are represented as String values.

See Also:

ConnectionFactoryOptions

Method Summary

Modifier and Type	Method and Description
String	name() Returns the name of the option.
static <T> Option<T>	sensitiveValueOf(String name) Returns a constant singleton instance of the sensitive option.
String	toString()
static <T> Option<T>	valueOf(String name) Returns a constant singleton instance of the option.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

sensitiveValueOf

public static <T> Option<T> sensitiveValueOf(String name)

Returns a constant singleton instance of the sensitive option.

Type Parameters:

T - the value type of the option

Parameters:

name - the name of the option to return

Returns:

a constant singleton instance of the option

Throws:

IllegalArgumentException - if name is null or empty

valueOf

public static <T> Option<T> valueOf(String name)

Returns a constant singleton instance of the option.

Type Parameters:

T - the value type of the option

Parameters:

name - the name of the option to return

Returns:

a constant singleton instance of the option

Throws:

IllegalArgumentException - if name is null or empty

name

public String name()

Returns the name of the option.

Returns:

the name of the option

toString

public String toString()

Overrides:

toString in class Object