public interface

SqlParameterSource

org.springframework.jdbc.core.namedparam.SqlParameterSource
Known Indirect Subclasses

Class Overview

Interface that defines common functionality for objects that can offer parameter values for named SQL parameters, serving as argument for NamedParameterJdbcTemplate operations.

This interface allows for the specification of SQL type in addition to parameter values. All parameter values and types are identified by specifying the name of the parameter.

Intended to wrap various implementations like a Map or a JavaBean with a consistent interface.

See Also

Summary

Constants
int TYPE_UNKNOWN Constant that indicates an unknown (or unspecified) SQL type.
Public Methods
abstract int getSqlType(String paramName)
Determine the SQL type for the specified named parameter.
abstract String getTypeName(String paramName)
Determine the type name for the specified named parameter.
abstract Object getValue(String paramName)
Return the parameter value for the requested named parameter.
abstract boolean hasValue(String paramName)
Determine whether there is a value for the specified named parameter.

Constants

public static final int TYPE_UNKNOWN

Constant that indicates an unknown (or unspecified) SQL type. To be returned from getType when no specific SQL type known.

See Also
Constant Value: -2147483648 (0x80000000)

Public Methods

public abstract int getSqlType (String paramName)

Determine the SQL type for the specified named parameter.

Parameters
paramName the name of the parameter
Returns
  • the SQL type of the specified parameter, or TYPE_UNKNOWN if not known
See Also

public abstract String getTypeName (String paramName)

Determine the type name for the specified named parameter.

Parameters
paramName the name of the parameter
Returns
  • the type name of the specified parameter, or null if not known

public abstract Object getValue (String paramName)

Return the parameter value for the requested named parameter.

Parameters
paramName the name of the parameter
Returns
  • the value of the specified parameter
Throws
IllegalArgumentException if there is no value for the requested parameter

public abstract boolean hasValue (String paramName)

Determine whether there is a value for the specified named parameter.

Parameters
paramName the name of the parameter
Returns
  • whether there is a value defined