Spring Framework 6.1.4 · org.springframework.jdbc.core.SqlParameter

Modifier and Type	Field and Description
private String	name
private Integer	scale
private final int	sqlType
private String	typeName

Constructor Summary

Access	Constructor and Description
public	SqlParameter(int the SQL type of the parameter according to `java.sql.Types` sqlType) Create a new anonymous SqlParameter, supplying the SQL type.
public	SqlParameter(int the SQL type of the parameter according to `java.sql.Types` sqlType, String the type name of the parameter (optional) typeName) Create a new anonymous SqlParameter, supplying the SQL type.
public	SqlParameter(int the SQL type of the parameter according to `java.sql.Types` sqlType, int the number of digits after the decimal point (for DECIMAL and NUMERIC types) scale) Create a new anonymous SqlParameter, supplying the SQL type.
public	SqlParameter(String the name of the parameter, as used in input and output maps name, int the SQL type of the parameter according to `java.sql.Types` sqlType) Create a new SqlParameter, supplying name and SQL type.
public	SqlParameter(String the name of the parameter, as used in input and output maps name, int the SQL type of the parameter according to `java.sql.Types` sqlType, String the type name of the parameter (optional) typeName) Create a new SqlParameter, supplying name and SQL type.
public	SqlParameter(String the name of the parameter, as used in input and output maps name, int the SQL type of the parameter according to `java.sql.Types` sqlType, int the number of digits after the decimal point (for DECIMAL and NUMERIC types) scale) Create a new SqlParameter, supplying name and SQL type.
public	SqlParameter(SqlParameter the SqlParameter object to copy from otherParam) Copy constructor.

Method Summary

Modifier and Type	Method and Description
public String	getName() Return the name of the parameter, or `null` if anonymous.
public Integer	getScale() Return the scale of the parameter, if any.
public int	getSqlType() Return the SQL type of the parameter.
public String	getTypeName() Return the type name of the parameter, if any.
public boolean	isInputValueProvided() Return whether this parameter holds input values that should be set before execution even if they are `null`.
public boolean	isResultsParameter() Return whether this parameter is an implicit return parameter used during the results processing of `CallableStatement.getMoreResults/getUpdateCount`.
public static List<SqlParameter>	sqlTypesToAnonymousParameterList(int... types) Convert a list of JDBC types, as defined in `java.sql.Types`, to a List of SqlParameter objects as used in this package.

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

Field Detail

name	back to summary
private String name Annotations @Nullable

scale	back to summary
private Integer scale Annotations @Nullable

sqlType	back to summary
private final int sqlType

typeName	back to summary
private String typeName Annotations @Nullable

Constructor Detail

SqlParameter back to summary

SqlParameter	back to summary
public SqlParameter(int sqlType) Create a new anonymous SqlParameter, supplying the SQL type. Parameters sqlType:int the SQL type of the parameter according to `java.sql.Types`

public SqlParameter(int sqlType)

Create a new anonymous SqlParameter, supplying the SQL type.

Parameters

sqlType:int: the SQL type of the parameter according to java.sql.Types

SqlParameter back to summary

SqlParameter	back to summary
public SqlParameter(int sqlType, String typeName) Create a new anonymous SqlParameter, supplying the SQL type. Parameters sqlType:int the SQL type of the parameter according to `java.sql.Types` typeName:String the type name of the parameter (optional)

public SqlParameter(int sqlType, String typeName)

Create a new anonymous SqlParameter, supplying the SQL type.

Parameters

sqlType:int: the SQL type of the parameter according to java.sql.Types
typeName:String: the type name of the parameter (optional)

SqlParameter back to summary

SqlParameter	back to summary
public SqlParameter(int sqlType, int scale) Create a new anonymous SqlParameter, supplying the SQL type. Parameters sqlType:int the SQL type of the parameter according to `java.sql.Types` scale:int the number of digits after the decimal point (for DECIMAL and NUMERIC types)

public SqlParameter(int sqlType, int scale)

Create a new anonymous SqlParameter, supplying the SQL type.

Parameters

sqlType:int: the SQL type of the parameter according to java.sql.Types
scale:int: the number of digits after the decimal point (for DECIMAL and NUMERIC types)

SqlParameter back to summary

SqlParameter	back to summary
public SqlParameter(String name, int sqlType) Create a new SqlParameter, supplying name and SQL type. Parameters name:String the name of the parameter, as used in input and output maps sqlType:int the SQL type of the parameter according to `java.sql.Types`

public SqlParameter(String name, int sqlType)

Create a new SqlParameter, supplying name and SQL type.

Parameters

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

SqlParameter back to summary

SqlParameter	back to summary
public SqlParameter(String name, int sqlType, String typeName) Create a new SqlParameter, supplying name and SQL type. Parameters name:String the name of the parameter, as used in input and output maps sqlType:int the SQL type of the parameter according to `java.sql.Types` typeName:String the type name of the parameter (optional)

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

Create a new SqlParameter, supplying name and SQL type.

Parameters

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

SqlParameter back to summary

SqlParameter	back to summary
public SqlParameter(String name, int sqlType, int scale) Create a new SqlParameter, supplying name and SQL type. Parameters name:String the name of the parameter, as used in input and output maps sqlType:int the SQL type of the parameter according to `java.sql.Types` scale:int the number of digits after the decimal point (for DECIMAL and NUMERIC types)

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

Create a new SqlParameter, supplying name and SQL type.

Parameters

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

SqlParameter	back to summary
public SqlParameter(SqlParameter otherParam) Copy constructor. Parameters otherParam:SqlParameter the SqlParameter object to copy from

SqlParameter

back to summary

public SqlParameter(SqlParameter otherParam)

Copy constructor.

Parameters

otherParam:SqlParameter: the SqlParameter object to copy from

Method Detail

getName back to summary

getName	back to summary
public String getName() Return the name of the parameter, or `null` if anonymous. Annotations @Nullable

public String getName()

Return the name of the parameter, or null if anonymous.

Annotations

@Nullable

getScale	back to summary
public Integer getScale() Return the scale of the parameter, if any. Annotations @Nullable

getScale

back to summary

public Integer getScale()

Return the scale of the parameter, if any.

Annotations

@Nullable

getSqlType	back to summary
public int getSqlType() Return the SQL type of the parameter.

getTypeName	back to summary
public String getTypeName() Return the type name of the parameter, if any. Annotations @Nullable

getTypeName

back to summary

public String getTypeName()

Return the type name of the parameter, if any.

Annotations

@Nullable

isInputValueProvided back to summary

isInputValueProvided	back to summary
public boolean isInputValueProvided() Return whether this parameter holds input values that should be set before execution even if they are `null`. This implementation always returns `true`.

public boolean isInputValueProvided()

Return whether this parameter holds input values that should be set before execution even if they are null.

This implementation always returns true.

isResultsParameter back to summary

isResultsParameter	back to summary
public boolean isResultsParameter() Return whether this parameter is an implicit return parameter used during the results processing of `CallableStatement.getMoreResults/getUpdateCount`. This implementation always returns `false`.

public boolean isResultsParameter()

Return whether this parameter is an implicit return parameter used during the results processing of CallableStatement.getMoreResults/getUpdateCount.

This implementation always returns false.

sqlTypesToAnonymousParameterList	back to summary
public static List<SqlParameter> sqlTypesToAnonymousParameterList(int... types) Convert a list of JDBC types, as defined in `java.sql.Types`, to a List of SqlParameter objects as used in this package.

public Class SqlParameter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail