Reactive Relational Database Connectivity - SPI 1.0.0.RELEASE · io.r2dbc.spi.Option

Modifier and Type	Field and Description
private static final ConstantPool<Option<?>>	CONSTANTS
private final String	name
private final boolean	sensitive

Access	Constructor and Description
private	Option(String name, boolean sensitive)

Method Summary

Modifier and Type	Method and Description
public T	Returns: the object after casting, or null if obj is `null`. cast(Object the object to be cast obj) Casts an object to the class or interface represented by this option object.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public String	Returns: the name of the option name() Returns the name of the option.
pack-priv boolean	sensitive()
public static < the value type of the option T> Option<T>	Returns: a constant singleton instance of the option sensitiveValueOf(String the name of the option to return name) Returns a constant singleton instance of the sensitive option.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public static < the value type of the option T> Option<T>	Returns: a constant singleton instance of the option valueOf(String the name of the option to return name) Returns a constant singleton instance of the option.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

CONSTANTS	back to summary
private static final ConstantPool<Option<?>> CONSTANTS

name	back to summary
private final String name

sensitive	back to summary
private final boolean sensitive

Option	back to summary
private Option(String name, boolean sensitive)

Method Detail

cast back to summary

cast	back to summary
public T cast(Object obj) Casts an object to the class or interface represented by this option object. Parameters obj:Object the object to be cast Returns:T the object after casting, or null if obj is `null`. Annotations @Nullable @SuppressWarnings:unchecked Since 0.9

public T cast(Object obj)

Casts an object to the class or interface represented by this option object.

Parameters

obj:Object: the object to be cast

Returns:T

the object after casting, or null if obj is null.

Annotations

@Nullable
@SuppressWarnings:unchecked

Since

0.9

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

name	back to summary
public String name() Returns the name of the option. Returns:String the name of the option

name

back to summary

public String name()

Returns the name of the option.

Returns:String: the name of the option

sensitive	back to summary
pack-priv boolean sensitive()

sensitiveValueOf back to summary

sensitiveValueOf	back to summary
public static <T> Option<T> sensitiveValueOf(String name) Returns a constant singleton instance of the sensitive option. Parameters <T> the value type of the option name:String the name of the option to return Returns:Option<T> a constant singleton instance of the option Annotations @SuppressWarnings:unchecked Exceptions IllegalArgumentException: if `name` is `null` or empty

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

Returns a constant singleton instance of the sensitive option.

Parameters

<T>: the value type of the option
name:String: the name of the option to return

Returns:Option<T>

a constant singleton instance of the option

Annotations

@SuppressWarnings:unchecked

Exceptions

IllegalArgumentException:: if name is null or empty

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

valueOf back to summary

valueOf	back to summary
public static <T> Option<T> valueOf(String name) Returns a constant singleton instance of the option. Parameters <T> the value type of the option name:String the name of the option to return Returns:Option<T> a constant singleton instance of the option Annotations @SuppressWarnings:unchecked Exceptions IllegalArgumentException: if `name` is `null` or empty

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

Returns a constant singleton instance of the option.

Parameters

<T>: the value type of the option
name:String: the name of the option to return

Returns:Option<T>

a constant singleton instance of the option

Annotations

@SuppressWarnings:unchecked

Exceptions

IllegalArgumentException:: if name is null or empty

public final Class Option<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail