Class ResultSetSupportingSqlParameter

java.lang.Object

org.springframework.jdbc.core.SqlParameter

org.springframework.jdbc.core.ResultSetSupportingSqlParameter

Direct Known Subclasses:

SqlOutParameter, SqlReturnResultSet

public class ResultSetSupportingSqlParameter
extends SqlParameter

Common base class for ResultSet-supporting SqlParameters like SqlOutParameter and SqlReturnResultSet.

Since:

1.0.2

Author:

Juergen Hoeller

Constructor Summary

Constructors

Constructor	Description
ResultSetSupportingSqlParameter(String name, int sqlType)	Create a new ResultSetSupportingSqlParameter.
ResultSetSupportingSqlParameter(String name, int sqlType, int scale)	Create a new ResultSetSupportingSqlParameter.
ResultSetSupportingSqlParameter(String name, int sqlType, @Nullable String typeName)	Create a new ResultSetSupportingSqlParameter.
ResultSetSupportingSqlParameter(String name, int sqlType, ResultSetExtractor<?> rse)	Create a new ResultSetSupportingSqlParameter.
ResultSetSupportingSqlParameter(String name, int sqlType, RowCallbackHandler rch)	Create a new ResultSetSupportingSqlParameter.
ResultSetSupportingSqlParameter(String name, int sqlType, RowMapper<?> rm)	Create a new ResultSetSupportingSqlParameter.

Method Summary

Modifier and Type	Method	Description
@Nullable ResultSetExtractor<?>	getResultSetExtractor()	Return the ResultSetExtractor held by this parameter, if any.
@Nullable RowCallbackHandler	getRowCallbackHandler()	Return the RowCallbackHandler held by this parameter, if any.
@Nullable RowMapper<?>	getRowMapper()	Return the RowMapper held by this parameter, if any.
boolean	isInputValueProvided()	This implementation always returns false.
boolean	isResultSetSupported()	Does this parameter support a ResultSet, i.e.

Methods inherited from class SqlParameter

getName, getScale, getSqlType, getTypeName, isResultsParameter, sqlTypesToAnonymousParameterList

Methods inherited from class Object

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

Constructor Details

ResultSetSupportingSqlParameter

public ResultSetSupportingSqlParameter(String name,
 int sqlType)

Create a new ResultSetSupportingSqlParameter.

Parameters:

name - the name of the parameter, as used in input and output maps

sqlType - the parameter SQL type according to java.sql.Types

ResultSetSupportingSqlParameter

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

Create a new ResultSetSupportingSqlParameter.

Parameters:

name - the name of the parameter, as used in input and output maps

sqlType - the parameter SQL type according to java.sql.Types

scale - the number of digits after the decimal point (for DECIMAL and NUMERIC types)

ResultSetSupportingSqlParameter

public ResultSetSupportingSqlParameter(String name,
 int sqlType,
 @Nullable String typeName)

Create a new ResultSetSupportingSqlParameter.

Parameters:

name - the name of the parameter, as used in input and output maps

sqlType - the parameter SQL type according to java.sql.Types

typeName - the type name of the parameter (optional)

ResultSetSupportingSqlParameter

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

Create a new ResultSetSupportingSqlParameter.

Parameters:

name - the name of the parameter, as used in input and output maps

sqlType - the parameter SQL type according to java.sql.Types

rse - the ResultSetExtractor to use for parsing the ResultSet

ResultSetSupportingSqlParameter

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

Create a new ResultSetSupportingSqlParameter.

Parameters:

name - the name of the parameter, as used in input and output maps

sqlType - the parameter SQL type according to java.sql.Types

rch - the RowCallbackHandler to use for parsing the ResultSet

ResultSetSupportingSqlParameter

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

Create a new ResultSetSupportingSqlParameter.

Parameters:

name - the name of the parameter, as used in input and output maps

sqlType - the parameter SQL type according to java.sql.Types

rm - the RowMapper to use for parsing the ResultSet

Method Details

isResultSetSupported

public boolean isResultSetSupported()

Does this parameter support a ResultSet, i.e. does it hold a ResultSetExtractor, RowCallbackHandler or RowMapper?

getResultSetExtractor

public @Nullable ResultSetExtractor<?> getResultSetExtractor()

Return the ResultSetExtractor held by this parameter, if any.

getRowCallbackHandler

public @Nullable RowCallbackHandler getRowCallbackHandler()

Return the RowCallbackHandler held by this parameter, if any.

getRowMapper

public @Nullable RowMapper<?> getRowMapper()

Return the RowMapper held by this parameter, if any.

isInputValueProvided

public boolean isInputValueProvided()

This implementation always returns false.

Overrides:

isInputValueProvided in class SqlParameter