Top Description Inners Constructors Methods
io.r2dbc.spi

public final Class Parameters

extends Object
Class Inheritance

Utility to create Parameter objects.
Since
0.9

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
private static class
private static class
private static class
private static class

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static Parameter

Returns:

the in parameter.
in
(Type
the type to be sent to the database.
type
)

Create a NULL IN parameter using the given Type.

public static Parameter

Returns:

the in parameter.
in
(Class<?>
the type to be used for type inference.
type
)

Create a NULL IN parameter using type inference and the given type hint.

public static Parameter

Returns:

the in parameter.
in
(Object
the value to be used for type inference.
value
)

Create a IN parameter using the given value.

public static Parameter

Returns:

the in parameter.
in
(Type
the type to be sent to the database.
type
,
Object
the value associated with the parameter, can be null.
value
)

Create a IN parameter using the given Type and value.

public static Parameter

Returns:

the in/out parameter.
inOut
(Type
the type to be sent to the database.
type
)

Create a NULL IN/OUT parameter using the given Type.

public static Parameter

Returns:

the in/out parameter.
inOut
(Class<?>
the type to be used for type inference.
type
)

Create a NULL IN/OUT parameter using type inference and the given type hint.

public static Parameter

Returns:

the in/out parameter.
inOut
(Object
the value to be used for type inference.
value
)

Create a IN/OUT parameter using the given value.

public static Parameter

Returns:

the in/out parameter.
inOut
(Type
the type to be sent to the database.
type
,
Object
the value associated with the parameter, can be null.
value
)

Create a IN/OUT parameter using the given Type and value.

public static Parameter

Returns:

the out parameter.
out
(Type
the type to be sent to the database.
type
)

Create a OUT parameter using the given Type.

public static Parameter

Returns:

the out parameter.
out
(Class<?>
the type to be used for type inference.
type
)

Create a OUT parameter using type inference and the given type hint.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Parametersback to summary
private Parameters()

Method Detail

inback to summary
public static Parameter in(Type type)

Create a NULL IN parameter using the given Type.

Parameters
type:Type

the type to be sent to the database.

Returns:Parameter

the in parameter.

Exceptions
IllegalArgumentException:
if type is null.
inback to summary
public static Parameter in(Class<?> type)

Create a NULL IN parameter using type inference and the given type hint. The actual Type is inferred during statement execution.

Parameters
type:Class<?>

the type to be used for type inference.

Returns:Parameter

the in parameter.

Exceptions
IllegalArgumentException:
if type is null.
inback to summary
public static Parameter in(Object value)

Create a IN parameter using the given value. The actual Type is inferred during statement execution.

Parameters
value:Object

the value to be used for type inference.

Returns:Parameter

the in parameter.

Exceptions
IllegalArgumentException:
if value is null.
inback to summary
public static Parameter in(Type type, Object value)

Create a IN parameter using the given Type and value.

Parameters
type:Type

the type to be sent to the database.

value:Object

the value associated with the parameter, can be null.

Returns:Parameter

the in parameter.

Exceptions
IllegalArgumentException:
if type is null.
inOutback to summary
public static Parameter inOut(Type type)

Create a NULL IN/OUT parameter using the given Type.

Parameters
type:Type

the type to be sent to the database.

Returns:Parameter

the in/out parameter.

Exceptions
IllegalArgumentException:
if type is null.
inOutback to summary
public static Parameter inOut(Class<?> type)

Create a NULL IN/OUT parameter using type inference and the given type hint. The actual Type is inferred during statement execution.

Parameters
type:Class<?>

the type to be used for type inference.

Returns:Parameter

the in/out parameter.

Exceptions
IllegalArgumentException:
if type is null.
inOutback to summary
public static Parameter inOut(Object value)

Create a IN/OUT parameter using the given value. The actual Type is inferred during statement execution.^

Parameters
value:Object

the value to be used for type inference.

Returns:Parameter

the in/out parameter.

Exceptions
IllegalArgumentException:
if value is null.
inOutback to summary
public static Parameter inOut(Type type, Object value)

Create a IN/OUT parameter using the given Type and value.

Parameters
type:Type

the type to be sent to the database.

value:Object

the value associated with the parameter, can be null.

Returns:Parameter

the in/out parameter.

Exceptions
IllegalArgumentException:
if type is null.
outback to summary
public static Parameter out(Type type)

Create a OUT parameter using the given Type.

Parameters
type:Type

the type to be sent to the database.

Returns:Parameter

the out parameter.

Exceptions
IllegalArgumentException:
if type is null.
outback to summary
public static Parameter out(Class<?> type)

Create a OUT parameter using type inference and the given type hint. The actual Type is inferred during statement execution.

Parameters
type:Class<?>

the type to be used for type inference.

Returns:Parameter

the out parameter.

Exceptions
IllegalArgumentException:
if type is null.
io.r2dbc.spi back to summary

private Class Parameters.DefaultInferredType

extends Object
implements InferredType, Type
Class Inheritance
All Implemented Interfaces
io.r2dbc.spi.Type, io.r2dbc.spi.Type.InferredType

Field Summary

Modifier and TypeField and Description
private final Class<?>

Constructor Summary

AccessConstructor and Description
pack-priv

Method Summary

Modifier and TypeMethod and Description
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 Class<?>
public String
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

javaTypeback to summary
private final Class<?> javaType

Constructor Detail

DefaultInferredTypeback to summary
pack-priv DefaultInferredType(Class<?> javaType)

Method Detail

equalsback 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
getJavaTypeback to summary
public Class<?> getJavaType()

Implements io.r2dbc.spi.Type.getJavaType.

Returns:Class<?>

Doc from io.r2dbc.spi.Type.getJavaType.

default Java type.

Annotations
@Override
getNameback to summary
public String getName()

Implements io.r2dbc.spi.Type.getName.

Returns:String

Doc from io.r2dbc.spi.Type.getName.

type name.

Annotations
@Override
hashCodeback 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
toStringback 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
io.r2dbc.spi back to summary

private Class Parameters.DefaultParameter

extends Object
implements Parameter
Class Inheritance
All Implemented Interfaces
io.r2dbc.spi.Parameter
Known Direct Subclasses
io.r2dbc.spi.Parameters.InParameter, io.r2dbc.spi.Parameters.OutParameter, io.r2dbc.spi.Parameters.InOutParameter

Field Summary

Modifier and TypeField and Description
private final Type
private final Object

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
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 Type
getType()

Implements io.r2dbc.spi.Parameter.getType.

Returns the parameter.
public Object
getValue()

Implements io.r2dbc.spi.Parameter.getValue.

Returns the value.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAlltoStringwaitwaitwait

Field Detail

typeback to summary
private final Type type
valueback to summary
private final Object value
Annotations
@Nullable

Constructor Detail

DefaultParameterback to summary
public DefaultParameter(Type type, Object value)

Method Detail

equalsback 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
getTypeback to summary
public Type getType()

Implements io.r2dbc.spi.Parameter.getType.

Doc from io.r2dbc.spi.Parameter.getType.

Returns the parameter.

Returns:Type

the type to be sent to the database.

Annotations
@Override
getValueback to summary
public Object getValue()

Implements io.r2dbc.spi.Parameter.getValue.

Doc from io.r2dbc.spi.Parameter.getValue.

Returns the value.

Returns:Object

the value for this parameter. Value can be null.

Annotations
@Override
hashCodeback 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
io.r2dbc.spi back to summary

private Class Parameters.InOutParameter

extends DefaultParameter
implements In, Out
Class Inheritance
All Implemented Interfaces
io.r2dbc.spi.Parameter.Out, io.r2dbc.spi.Parameter.In

Constructor Summary

AccessConstructor and Description
public
InOutParameter(Type type, Object value)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides io.r2dbc.spi.Parameters.DefaultParameter.equals.

Indicates whether some other object is "equal to" this one.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from io.r2dbc.spi.Parameters.DefaultParameter:
getTypegetValuehashCode

Constructor Detail

InOutParameterback to summary
public InOutParameter(Type type, Object value)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides io.r2dbc.spi.Parameters.DefaultParameter.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
toStringback 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
io.r2dbc.spi back to summary

private Class Parameters.InParameter

extends DefaultParameter
implements In
Class Inheritance
All Implemented Interfaces
io.r2dbc.spi.Parameter.In

Constructor Summary

AccessConstructor and Description
public
InParameter(Type type, Object value)

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides io.r2dbc.spi.Parameters.DefaultParameter.equals.

Indicates whether some other object is "equal to" this one.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from io.r2dbc.spi.Parameters.DefaultParameter:
getTypegetValuehashCode

Constructor Detail

InParameterback to summary
public InParameter(Type type, Object value)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides io.r2dbc.spi.Parameters.DefaultParameter.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
toStringback 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
io.r2dbc.spi back to summary

private Class Parameters.OutParameter

extends DefaultParameter
implements Out
Class Inheritance
All Implemented Interfaces
io.r2dbc.spi.Parameter.Out

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public boolean
equals(Object
the reference object with which to compare.
o
)

Overrides io.r2dbc.spi.Parameters.DefaultParameter.equals.

Indicates whether some other object is "equal to" this one.
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from io.r2dbc.spi.Parameters.DefaultParameter:
getTypegetValuehashCode

Constructor Detail

OutParameterback to summary
public OutParameter(Type type)

Method Detail

equalsback to summary
public boolean equals(Object o)

Overrides io.r2dbc.spi.Parameters.DefaultParameter.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
toStringback 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