Package org.apache.commons.dbutils
Class OutParameter<T>
java.lang.Object
org.apache.commons.dbutils.OutParameter<T>
- Type Parameters:
T
- the class of the parameter; should be compatible via cast with the class returned by theCallableStatement.getObject(int)
method.
Represents an OUT parameter for a stored procedure. When running a stored
procedure with
QueryRunner
, pass an instance of
OutParameter
to indicate that the parameter at that index is an
OUT parameter. The value of the parameter may be obtained from the
OutParameter
instance via getValue()
.
INOUT parameters are also supported by setting the value
of
the OutParameter
instance before invoking the stored procedure.
-
Constructor Summary
ConstructorsConstructorDescriptionOutParameter
(int sqlType, Class<T> javaType) Construct anOutParameter
for the given JDBC SQL type and Java type.OutParameter
(int sqlType, Class<T> javaType, T value) Construct anOutParameter
for the given JDBC SQL type and Java type and with the given value. -
Method Summary
-
Constructor Details
-
OutParameter
Construct anOutParameter
for the given JDBC SQL type and Java type.- Parameters:
sqlType
- the JDBC SQL type of the parameter as injava.sql.Types
.javaType
- the Java class of the parameter value, cast compatible with the type returned byCallableStatement.getObject(int)
for the JDBC type given bysqlType
.
-
OutParameter
Construct anOutParameter
for the given JDBC SQL type and Java type and with the given value. The parameter will be treated as an INOUT parameter if the value is null.- Parameters:
sqlType
- the JDBC SQL type of the parameter as injava.sql.Types
.javaType
- the Java class of the parameter value, cast compatible with the type returned byCallableStatement.getObject(int)
for the JDBC type given bysqlType
.value
- the IN value of the parameter
-
-
Method Details
-
getJavaType
Get the Java class for this OUT parameter.- Returns:
- the Java class for this OUT parameter.
-
getSqlType
Get the JDBC SQL type for this OUT parameter.- Returns:
- the JDBC SQL type for this OUT parameter.
-
getValue
Get the value of the OUT parameter. After the stored procedure has been executed, the value is the value returned via this parameter.- Returns:
- the value of the OUT parameter.
-
setValue
Set the value of the OUT parameter. If the value is not null when the stored procedure is executed, then the parameter will be treated like an INOUT parameter.- Parameters:
value
- the new value for the parameter.
-
toString
-