Top Fields Constructors Methods
org.hibernate.query.spi

public abstract Class AbstractQueryParameter<T>

extends Object
implements QueryParameterImplementor<T>
Class Inheritance
All Implemented Interfaces
org.hibernate.query.spi.QueryParameterImplementor, org.hibernate.query.QueryParameter, jakarta.persistence.Parameter
Known Direct Subclasses
org.hibernate.procedure.internal.ProcedureParameterImpl, org.hibernate.query.internal.QueryParameterNamedImpl, org.hibernate.query.internal.QueryParameterPositionalImpl
Imports
org.hibernate.query.BindableType, .QueryLogging, org.hibernate.query.spi.QueryParameterImplementor
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private boolean
allowMultiValuedBinding

private BindableType<T>
anticipatedType

Constructor Summary

AccessConstructor and Description
public
AbstractQueryParameter(boolean allowMultiValuedBinding, BindableType<T> anticipatedType)

Method Summary

Modifier and TypeMethod and Description
public boolean
allowsMultiValuedBinding()

Implements org.hibernate.query.QueryParameter.allowsMultiValuedBinding.

Does this parameter allow multi-valued (collection, array, etc) binding?
public void
applyAnticipatedType(BindableType<J> type)

Implements org.hibernate.query.spi.QueryParameterImplementor.applyAnticipatedType.

public void
disallowMultiValuedBinding()

Implements org.hibernate.query.spi.QueryParameterImplementor.disallowMultiValuedBinding.

public BindableType<T>
getHibernateType()

Implements org.hibernate.query.QueryParameter.getHibernateType.

Get the Hibernate Type associated with this parameter, if one.
public String
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.
public Class<T>
getParameterType()

Implements jakarta.persistence.Parameter.getParameterType.

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

Implements jakarta.persistence.Parameter.getPosition.

Return the parameter position, or null if the parameter is not a positional parameter.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

allowMultiValuedBindingback to summary
private boolean allowMultiValuedBinding
anticipatedTypeback to summary
private BindableType<T> anticipatedType

Constructor Detail

AbstractQueryParameterback to summary
public AbstractQueryParameter(boolean allowMultiValuedBinding, BindableType<T> anticipatedType)

Method Detail

allowsMultiValuedBindingback to summary
public boolean allowsMultiValuedBinding()

Implements org.hibernate.query.QueryParameter.allowsMultiValuedBinding.

Doc from org.hibernate.query.QueryParameter.allowsMultiValuedBinding.

Does this parameter allow multi-valued (collection, array, etc) binding?

This is only valid for HQL/JPQL and (I think) Criteria queries, and is determined based on the context of the parameters declaration.

Returns:boolean

true indicates that multi-valued binding is allowed for this parameter

Annotations
@Override
applyAnticipatedTypeback to summary
public void applyAnticipatedType(BindableType<J> type)

Implements org.hibernate.query.spi.QueryParameterImplementor.applyAnticipatedType.

Annotations
@Override
disallowMultiValuedBindingback to summary
public void disallowMultiValuedBinding()

Implements org.hibernate.query.spi.QueryParameterImplementor.disallowMultiValuedBinding.

Annotations
@Override
getHibernateTypeback to summary
public BindableType<T> getHibernateType()

Implements org.hibernate.query.QueryParameter.getHibernateType.

Doc from org.hibernate.query.QueryParameter.getHibernateType.

Get the Hibernate Type associated with this parameter, if one. May return null.

Returns:BindableType<T>

The associated Hibernate Type, may be null.

Annotations
@Override
getNameback to summary
public String 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
getParameterTypeback to summary
public Class<T> 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()

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