org.hibernate.query

Interface ParameterMetadata

All Known Implementing Classes:

ParameterMetadataImpl, ProcedureParameterMetadata

public interface ParameterMetadata

Access to known information about the parameters for a query.

Author:

Steve Ebersole

Method Summary

Modifier and Type	Method and Description
Set<QueryParameter<?>>	collectAllParameters()
Set<Parameter<?>>	collectAllParametersJpa()
boolean	containsReference(QueryParameter parameter)
Set<String>	getNamedParameterNames() Return the names of all named parameters of the query.
Collection<QueryParameter>	getNamedParameters()
int	getParameterCount()
int	getPositionalParameterCount() Returns the number of positional parameters.
Collection<QueryParameter>	getPositionalParameters()
<T> QueryParameter<T>	getQueryParameter(Integer position)
<T> QueryParameter<T>	getQueryParameter(String name)
boolean	hasNamedParameters() Does this parameter set contain any named parameters?
boolean	hasPositionalParameters() Does this parameter set contain any positional parameters?
<T> QueryParameter<T>	resolve(Parameter<T> param)
void	visitRegistrations(Consumer<QueryParameter> action)

Method Detail

hasNamedParameters

boolean hasNamedParameters()

Does this parameter set contain any named parameters?

Returns:

true if there are named parameters; false otherwise.

hasPositionalParameters

boolean hasPositionalParameters()

Does this parameter set contain any positional parameters?

Returns:

true if there are positional parameters; false otherwise.

collectAllParameters

Set<QueryParameter<?>> collectAllParameters()

collectAllParametersJpa

Set<Parameter<?>> collectAllParametersJpa()

getNamedParameterNames

Set<String> getNamedParameterNames()

Return the names of all named parameters of the query.

Returns:

the parameter names, in no particular order

getPositionalParameterCount

int getPositionalParameterCount()

Returns the number of positional parameters.

Returns:

The number of positional parameters.

getQueryParameter

<T> QueryParameter<T> getQueryParameter(String name)

getQueryParameter

<T> QueryParameter<T> getQueryParameter(Integer position)

resolve

<T> QueryParameter<T> resolve(Parameter<T> param)

getPositionalParameters

Collection<QueryParameter> getPositionalParameters()

getNamedParameters

Collection<QueryParameter> getNamedParameters()

getParameterCount

int getParameterCount()

containsReference

boolean containsReference(QueryParameter parameter)

visitRegistrations

void visitRegistrations(Consumer<QueryParameter> action)