Top Fields Constructors Methods
org.hibernate.procedure.internal

public Class ProcedureParameterImpl<T>

extends AbstractQueryParameter<T>
implements ProcedureParameterImplementor<T>
Class Inheritance
All Implemented Interfaces
org.hibernate.procedure.spi.ProcedureParameterImplementor, org.hibernate.query.spi.QueryParameterImplementor, org.hibernate.query.QueryParameter, jakarta.persistence.Parameter, org.hibernate.query.procedure.ProcedureParameter
Imports
java.sql.CallableStatement, .PreparedStatement, .SQLException, java.util.Locale, .Objects, org.hibernate.engine.jdbc.env.spi.ExtractedDatabaseMetaData, org.hibernate.metamodel.mapping.JdbcMapping, org.hibernate.procedure.ParameterTypeException, org.hibernate.procedure.spi.NamedCallableQueryMemento, .ParameterStrategy, .ProcedureCallImplementor, .ProcedureParameterImplementor, org.hibernate.query.BindableType, .OutputableType, org.hibernate.query.internal.BindingTypeHelper, org.hibernate.query.spi.AbstractQueryParameter, .QueryParameterBinding, org.hibernate.sql.exec.internal.JdbcCallParameterExtractorImpl, .JdbcCallParameterRegistrationImpl, .JdbcCallRefCursorExtractorImpl, .JdbcParameterImpl, org.hibernate.sql.exec.spi.ExecutionContext, .JdbcCallParameterRegistration, .JdbcParameterBinder, org.hibernate.type.BasicType, .ProcedureParameterNamedBinder, jakarta.persistence.ParameterMode
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final Class<T>
javaType

private final ParameterMode
mode

private final String
name

private final Integer
position

Constructor Summary

AccessConstructor and Description
public
ProcedureParameterImpl(String name, ParameterMode mode, Class<T> javaType, BindableType<T> hibernateType)

Used for named Query parameters

public
ProcedureParameterImpl(Integer position, ParameterMode mode, Class<T> javaType, BindableType<T> hibernateType)

Used for ordinal Query parameters

Method Summary

Modifier and TypeMethod and Description
private boolean
canDoNameParameterBinding(BindableType<?> hibernateType, ProcedureCallImplementor<?> procedureCall)

public boolean
equals(Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public ParameterMode
getMode()

Implements org.hibernate.query.procedure.ProcedureParameter.getMode.

Retrieves the parameter "mode".
public String
getName()

Overrides org.hibernate.query.spi.AbstractQueryParameter.getName.

Implements jakarta.persistence.Parameter.getName.

Return the parameter name, or null if the parameter is not a named parameter or no name has been assigned.
private JdbcParameterBinder
getParameterBinder(BindableType<T> typeToUse, String name)

public Class<T>
getParameterType()

Overrides org.hibernate.query.spi.AbstractQueryParameter.getParameterType.

Implements jakarta.persistence.Parameter.getParameterType.

Return the Java type of the parameter.
public Integer
getPosition()

Overrides org.hibernate.query.spi.AbstractQueryParameter.getPosition.

Implements jakarta.persistence.Parameter.getPosition.

Return the parameter position, or null if the parameter is not a positional parameter.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public JdbcCallParameterRegistration
toJdbcParameterRegistration(int startIndex, ProcedureCallImplementor<?> procedureCall)

Implements org.hibernate.procedure.spi.ProcedureParameterImplementor.toJdbcParameterRegistration.

public NamedCallableQueryMemento.ParameterMemento
toMemento()

Implements org.hibernate.query.spi.QueryParameterImplementor.toMemento.

public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
private void
validateBindableType(BindableType<T> bindableType, int startIndex)

Inherited from org.hibernate.query.spi.AbstractQueryParameter:
allowsMultiValuedBindingapplyAnticipatedTypedisallowMultiValuedBindinggetHibernateType

Field Detail

javaTypeback to summary
private final Class<T> javaType
modeback to summary
private final ParameterMode mode
nameback to summary
private final String name
positionback to summary
private final Integer position

Constructor Detail

ProcedureParameterImplback to summary
public ProcedureParameterImpl(String name, ParameterMode mode, Class<T> javaType, BindableType<T> hibernateType)

Used for named Query parameters

ProcedureParameterImplback to summary
public ProcedureParameterImpl(Integer position, ParameterMode mode, Class<T> javaType, BindableType<T> hibernateType)

Used for ordinal Query parameters

Method Detail

canDoNameParameterBindingback to summary
private boolean canDoNameParameterBinding(BindableType<?> hibernateType, ProcedureCallImplementor<?> procedureCall)
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o:Object

the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations
@Override
getModeback to summary
public ParameterMode getMode()

Implements org.hibernate.query.procedure.ProcedureParameter.getMode.

Doc from org.hibernate.query.procedure.ProcedureParameter.getMode.

Retrieves the parameter "mode". Only really pertinent in regards to procedure/function calls. In all other cases the mode would be ParameterMode#IN

Returns:ParameterMode

The parameter mode.

Annotations
@Override
getNameback to summary
public String getName()

Overrides org.hibernate.query.spi.AbstractQueryParameter.getName.

Implements jakarta.persistence.Parameter.getName.

Doc from jakarta.persistence.Parameter.getName.

Return the parameter name, or null if the parameter is not a named parameter or no name has been assigned.

Returns:String

parameter name

Annotations
@Override
getParameterBinderback to summary
private JdbcParameterBinder getParameterBinder(BindableType<T> typeToUse, String name)
getParameterTypeback to summary
public Class<T> getParameterType()

Overrides org.hibernate.query.spi.AbstractQueryParameter.getParameterType.

Implements jakarta.persistence.Parameter.getParameterType.

Doc from jakarta.persistence.Parameter.getParameterType.

Return the Java type of the parameter. Values bound to the parameter must be assignable to this type. This method is required to be supported for criteria queries only. Applications that use this method for Jakarta Persistence query language queries and native queries will not be portable.

Returns:Class<T>

the Java type of the parameter

Annotations
@Override
getPositionback to summary
public Integer getPosition()

Overrides org.hibernate.query.spi.AbstractQueryParameter.getPosition.

Implements jakarta.persistence.Parameter.getPosition.

Doc from jakarta.persistence.Parameter.getPosition.

Return the parameter position, or null if the parameter is not a positional parameter.

Returns:Integer

position of parameter

Annotations
@Override
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Returns:int

a hash code value for this object.

Annotations
@Override
toJdbcParameterRegistrationback to summary
public JdbcCallParameterRegistration toJdbcParameterRegistration(int startIndex, ProcedureCallImplementor<?> procedureCall)

Implements org.hibernate.procedure.spi.ProcedureParameterImplementor.toJdbcParameterRegistration.

Annotations
@Override
toMementoback to summary
public NamedCallableQueryMemento.ParameterMemento toMemento()

Implements org.hibernate.query.spi.QueryParameterImplementor.toMemento.

Annotations
@Override
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override
validateBindableTypeback to summary
private void validateBindableType(BindableType<T> bindableType, int startIndex)