Package org.hibernate.procedure.internal

Class FunctionReturnImpl<T>

java.lang.Object

org.hibernate.procedure.internal.FunctionReturnImpl<T>

All Implemented Interfaces:

jakarta.persistence.Parameter<T>, FunctionReturn<T>, FunctionReturnImplementor<T>, ProcedureParameterImplementor<T>, ProcedureParameter<T>, QueryParameter<T>, QueryParameterImplementor<T>

public class FunctionReturnImpl<T>
extends Object
implements FunctionReturnImplementor<T>

Constructor Summary

Constructors

Constructor	Description
FunctionReturnImpl(ProcedureCallImplementor<T> procedureCall, int sqlTypeCode)
FunctionReturnImpl(ProcedureCallImplementor<T> procedureCall, OutputableType<T> ormType)

Method Summary

Modifier and Type	Method	Description
boolean	allowsMultiValuedBinding()	Does this parameter allow multi-valued (collection, array, etc) binding?
void	applyAnticipatedType(BindableType type)
void	disallowMultiValuedBinding()
BindableType<T>	getHibernateType()	Get the Hibernate Type associated with this parameter, if one.
int	getJdbcTypeCode()
jakarta.persistence.ParameterMode	getMode()	Retrieves the parameter "mode".
String	getName()
Class	getParameterType()
Integer	getPosition()
JdbcCallFunctionReturn	toJdbcFunctionReturn(SharedSessionContractImplementor persistenceContext)
NamedCallableQueryMemento.ParameterMemento	toMemento()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.procedure.spi.FunctionReturnImplementor

toJdbcParameterRegistration

Constructor Detail

FunctionReturnImpl

public FunctionReturnImpl(ProcedureCallImplementor<T> procedureCall,
                          int sqlTypeCode)

FunctionReturnImpl

public FunctionReturnImpl(ProcedureCallImplementor<T> procedureCall,
                          OutputableType<T> ormType)

Method Detail

toJdbcFunctionReturn

public JdbcCallFunctionReturn toJdbcFunctionReturn(SharedSessionContractImplementor persistenceContext)

Specified by:

toJdbcFunctionReturn in interface FunctionReturnImplementor<T>

getJdbcTypeCode

public int getJdbcTypeCode()

Specified by:

getJdbcTypeCode in interface FunctionReturn<T>

getHibernateType

public BindableType<T> getHibernateType()

Description copied from interface: QueryParameter

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

Specified by:

getHibernateType in interface QueryParameter<T>

Returns:

The associated Hibernate Type, may be null.

getName

public String getName()

Specified by:

getName in interface jakarta.persistence.Parameter<T>

getPosition

public Integer getPosition()

Specified by:

getPosition in interface jakarta.persistence.Parameter<T>

getMode

public jakarta.persistence.ParameterMode getMode()

Description copied from interface: ProcedureParameter

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

Specified by:

getMode in interface ProcedureParameter<T>

Returns:

The parameter mode.

getParameterType

public Class getParameterType()

Specified by:

getParameterType in interface jakarta.persistence.Parameter<T>

disallowMultiValuedBinding

public void disallowMultiValuedBinding()

Specified by:

disallowMultiValuedBinding in interface QueryParameterImplementor<T>

applyAnticipatedType

public void applyAnticipatedType(BindableType type)

Specified by:

applyAnticipatedType in interface QueryParameterImplementor<T>

allowsMultiValuedBinding

public boolean allowsMultiValuedBinding()

Description copied from interface: QueryParameter

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.

Specified by:

allowsMultiValuedBinding in interface QueryParameter<T>

Returns:

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

toMemento

public NamedCallableQueryMemento.ParameterMemento toMemento()

Specified by:

toMemento in interface QueryParameterImplementor<T>