Top Description Fields Constructors Methods
org.springframework.jdbc.core.metadata

public Class CallParameterMetaData

extends Object
Class Inheritance
Imports
java.sql.DatabaseMetaData, org.springframework.lang.Nullable

Holder of meta-data for a specific parameter that is used for call processing.
Authors
Thomas Risberg, Juergen Hoeller
Since
2.5
See Also
GenericCallMetaDataProvider

Field Summary

Modifier and TypeField and Description
private final boolean
private final boolean
private final String
private final int
private final int
private final String

Constructor Summary

AccessConstructor and Description
public
CallParameterMetaData(boolean function, String columnName, int columnType, int sqlType, String typeName, boolean nullable)

Constructor taking all the properties including the function marker.

Method Summary

Modifier and TypeMethod and Description
public String
getParameterName()

Return the parameter name.

public int
getParameterType()

Return the parameter type.

public int
getSqlType()

Return the parameter SQL type.

public String
getTypeName()

Return the parameter type name.

public boolean
isFunction()

Return whether this parameter is declared in a function.

public boolean
isInOutParameter()

Determine whether the declared parameter qualifies as an 'in-out' parameter for our purposes: type DatabaseMetaData#procedureColumnInOut, or in case of a function, DatabaseMetaData#functionColumnInOut.

public boolean
isNullable()

Return whether the parameter is nullable.

public boolean
isOutParameter()

Determine whether the declared parameter qualifies as an 'out' parameter for our purposes: type DatabaseMetaData#procedureColumnOut, or in case of a function, DatabaseMetaData#functionColumnOut.

public boolean
isReturnParameter()

Determine whether the declared parameter qualifies as a 'return' parameter for our purposes: type DatabaseMetaData#procedureColumnReturn or DatabaseMetaData#procedureColumnResult, or in case of a function, DatabaseMetaData#functionReturn.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

functionback to summary
private final boolean function
nullableback to summary
private final boolean nullable
parameterNameback to summary
private final String parameterName
Annotations
@Nullable
parameterTypeback to summary
private final int parameterType
sqlTypeback to summary
private final int sqlType
typeNameback to summary
private final String typeName
Annotations
@Nullable

Constructor Detail

CallParameterMetaDataback to summary
public CallParameterMetaData(boolean function, String columnName, int columnType, int sqlType, String typeName, boolean nullable)

Constructor taking all the properties including the function marker.

Since
5.2.9

Method Detail

getParameterNameback to summary
public String getParameterName()

Return the parameter name.

Annotations
@Nullable
getParameterTypeback to summary
public int getParameterType()

Return the parameter type.

getSqlTypeback to summary
public int getSqlType()

Return the parameter SQL type.

getTypeNameback to summary
public String getTypeName()

Return the parameter type name.

Annotations
@Nullable
isFunctionback to summary
public boolean isFunction()

Return whether this parameter is declared in a function.

Since
5.2.9
isInOutParameterback to summary
public boolean isInOutParameter()

Determine whether the declared parameter qualifies as an 'in-out' parameter for our purposes: type DatabaseMetaData#procedureColumnInOut, or in case of a function, DatabaseMetaData#functionColumnInOut.

Since
5.3.31
isNullableback to summary
public boolean isNullable()

Return whether the parameter is nullable.

isOutParameterback to summary
public boolean isOutParameter()

Determine whether the declared parameter qualifies as an 'out' parameter for our purposes: type DatabaseMetaData#procedureColumnOut, or in case of a function, DatabaseMetaData#functionColumnOut.

Since
5.3.31
isReturnParameterback to summary
public boolean isReturnParameter()

Determine whether the declared parameter qualifies as a 'return' parameter for our purposes: type DatabaseMetaData#procedureColumnReturn or DatabaseMetaData#procedureColumnResult, or in case of a function, DatabaseMetaData#functionReturn.

Since
4.3.15