Top Description Fields Constructors Methods

org.springframework.jdbc.core

public Class SqlOutParameter

Class Inheritance

extends ResultSetSupportingSqlParameter

java.lang.Object
org.springframework.jdbc.core.SqlParameter
org.springframework.jdbc.core.ResultSetSupportingSqlParameter
org.springframework.jdbc.core.SqlOutParameter

Known Direct Subclasses

org.springframework.jdbc.core.SqlInOutParameter

Imports

java.sql.ResultSet, org.springframework.lang.Nullable

Subclass of SqlParameter to represent an output parameter. No additional properties: instanceof will be used to check for such types.

Output parameters - like all stored procedure parameters - must have names.

Authors: Rod Johnson, Thomas Risberg, Juergen Hoeller
See Also: SqlReturnResultSet, SqlInOutParameter

Field Summary

Modifier and Type	Field and Description
private SqlReturnType	sqlReturnType

Constructor Summary

Access	Constructor and Description
public	SqlOutParameter(String the name of the parameter, as used in input and output maps name, int the parameter SQL type according to `java.sql.Types` sqlType) Create a new SqlOutParameter.
public	SqlOutParameter(String the name of the parameter, as used in input and output maps name, int the parameter SQL type according to `java.sql.Types` sqlType, int the number of digits after the decimal point (for DECIMAL and NUMERIC types) scale) Create a new SqlOutParameter.
public	SqlOutParameter(String the name of the parameter, as used in input and output maps name, int the parameter SQL type according to `java.sql.Types` sqlType, String the type name of the parameter (optional) typeName) Create a new SqlOutParameter.
public	SqlOutParameter(String the name of the parameter, as used in input and output maps name, int the parameter SQL type according to `java.sql.Types` sqlType, String the type name of the parameter (optional) typeName, SqlReturnType custom value handler for complex type (optional) sqlReturnType) Create a new SqlOutParameter.
public	SqlOutParameter(String the name of the parameter, as used in input and output maps name, int the parameter SQL type according to `java.sql.Types` sqlType, ResultSetExtractor<?> the `ResultSetExtractor` to use for parsing the `ResultSet` rse) Create a new SqlOutParameter.
public	SqlOutParameter(String the name of the parameter, as used in input and output maps name, int the parameter SQL type according to `java.sql.Types` sqlType, RowCallbackHandler the `RowCallbackHandler` to use for parsing the `ResultSet` rch) Create a new SqlOutParameter.
public	SqlOutParameter(String the name of the parameter, as used in input and output maps name, int the parameter SQL type according to `java.sql.Types` sqlType, RowMapper<?> the `RowMapper` to use for parsing the `ResultSet` rm) Create a new SqlOutParameter.

Method Summary

Modifier and Type	Method and Description
public SqlReturnType	getSqlReturnType() Return the custom return type, if any.
public boolean	isReturnTypeSupported() Return whether this parameter holds a custom return type.

Inherited from org.springframework.jdbc.core.ResultSetSupportingSqlParameter:: getResultSetExtractor getRowCallbackHandler getRowMapper isInputValueProvided isResultSetSupported

Field Detail

sqlReturnType	back to summary
private SqlReturnType sqlReturnType Annotations @Nullable

Constructor Detail

SqlOutParameter back to summary

public SqlOutParameter(String name, int sqlType)

Create a new SqlOutParameter.

Parameters

name:String: the name of the parameter, as used in input and output maps
sqlType:int: the parameter SQL type according to java.sql.Types

SqlOutParameter back to summary

public SqlOutParameter(String name, int sqlType, int scale)

Create a new SqlOutParameter.

Parameters

name:String: the name of the parameter, as used in input and output maps
sqlType:int: the parameter SQL type according to java.sql.Types
scale:int: the number of digits after the decimal point (for DECIMAL and NUMERIC types)

SqlOutParameter back to summary

public SqlOutParameter(String name, int sqlType, String typeName)

Create a new SqlOutParameter.

Parameters

name:String: the name of the parameter, as used in input and output maps
sqlType:int: the parameter SQL type according to java.sql.Types
typeName:String: the type name of the parameter (optional)

SqlOutParameter back to summary

public SqlOutParameter(String name, int sqlType, String typeName, SqlReturnType sqlReturnType)

Create a new SqlOutParameter.

Parameters

name:String: the name of the parameter, as used in input and output maps
sqlType:int: the parameter SQL type according to java.sql.Types
typeName:String: the type name of the parameter (optional)
sqlReturnType:SqlReturnType: custom value handler for complex type (optional)

SqlOutParameter back to summary

public SqlOutParameter(String name, int sqlType, ResultSetExtractor<?> rse)

Create a new SqlOutParameter.

Parameters

name:String: the name of the parameter, as used in input and output maps
sqlType:int: the parameter SQL type according to java.sql.Types
rse:ResultSetExtractor<?>: the ResultSetExtractor to use for parsing the ResultSet

SqlOutParameter back to summary

public SqlOutParameter(String name, int sqlType, RowCallbackHandler rch)

Create a new SqlOutParameter.

Parameters

name:String: the name of the parameter, as used in input and output maps
sqlType:int: the parameter SQL type according to java.sql.Types
rch:RowCallbackHandler: the RowCallbackHandler to use for parsing the ResultSet

SqlOutParameter back to summary

public SqlOutParameter(String name, int sqlType, RowMapper<?> rm)

Create a new SqlOutParameter.

Parameters

name:String: the name of the parameter, as used in input and output maps
sqlType:int: the parameter SQL type according to java.sql.Types
rm:RowMapper<?>: the RowMapper to use for parsing the ResultSet

Method Detail

getSqlReturnType

back to summary

public SqlReturnType getSqlReturnType()

Return the custom return type, if any.

Annotations

@Nullable

isReturnTypeSupported	back to summary
public boolean isReturnTypeSupported() Return whether this parameter holds a custom return type.