public class SqlParameter extends Object
Parameters may be anonymous, in which case "name" is null
.
However, all parameters must define an SQL type according to Types
.
Types
Constructor and Description |
---|
SqlParameter(int sqlType)
Create a new anonymous SqlParameter, supplying the SQL type.
|
SqlParameter(int sqlType,
int scale)
Create a new anonymous SqlParameter, supplying the SQL type.
|
SqlParameter(int sqlType,
String typeName)
Create a new anonymous SqlParameter, supplying the SQL type.
|
SqlParameter(SqlParameter otherParam)
Copy constructor.
|
SqlParameter(String name,
int sqlType)
Create a new SqlParameter, supplying name and SQL type.
|
SqlParameter(String name,
int sqlType,
int scale)
Create a new SqlParameter, supplying name and SQL type.
|
SqlParameter(String name,
int sqlType,
String typeName)
Create a new SqlParameter, supplying name and SQL type.
|
Modifier and Type | Method and Description |
---|---|
String |
getName()
Return the name of the parameter, or
null if anonymous. |
Integer |
getScale()
Return the scale of the parameter, if any.
|
int |
getSqlType()
Return the SQL type of the parameter.
|
String |
getTypeName()
Return the type name of the parameter, if any.
|
boolean |
isInputValueProvided()
Return whether this parameter holds input values that should be set
before execution even if they are
null . |
boolean |
isResultsParameter()
Return whether this parameter is an implicit return parameter used during the
results processing of
CallableStatement.getMoreResults/getUpdateCount . |
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 SqlParameter(int sqlType)
sqlType
- the SQL type of the parameter according to java.sql.Types
public SqlParameter(int sqlType, @Nullable String typeName)
sqlType
- the SQL type of the parameter according to java.sql.Types
typeName
- the type name of the parameter (optional)public SqlParameter(int sqlType, int scale)
sqlType
- the SQL type of the parameter according to java.sql.Types
scale
- the number of digits after the decimal point
(for DECIMAL and NUMERIC types)public SqlParameter(String name, int sqlType)
name
- the name of the parameter, as used in input and output mapssqlType
- the SQL type of the parameter according to java.sql.Types
public SqlParameter(String name, int sqlType, @Nullable String typeName)
name
- the name of the parameter, as used in input and output mapssqlType
- the SQL type of the parameter according to java.sql.Types
typeName
- the type name of the parameter (optional)public SqlParameter(String name, int sqlType, int scale)
name
- the name of the parameter, as used in input and output mapssqlType
- the SQL type of the parameter according to java.sql.Types
scale
- the number of digits after the decimal point
(for DECIMAL and NUMERIC types)public SqlParameter(SqlParameter otherParam)
otherParam
- the SqlParameter object to copy frompublic int getSqlType()
public boolean isInputValueProvided()
null
.
This implementation always returns true
.
public boolean isResultsParameter()
CallableStatement.getMoreResults/getUpdateCount
.
This implementation always returns false
.
public static List<SqlParameter> sqlTypesToAnonymousParameterList(@Nullable int... types)
java.sql.Types
,
to a List of SqlParameter objects as used in this package.