Top Description Methods
org.hibernate.query

public Interface ParameterMetadata

Known Direct Implementers
org.hibernate.query.internal.ParameterMetadataImpl, org.hibernate.query.procedure.internal.ProcedureParameterMetadata
Imports
java.util.Collection, .Set, java.util.function.Consumer, javax.persistence.Parameter

Access to known information about the parameters for a query.
Author
Steve Ebersole

Method Summary

Modifier and TypeMethod and Description
public Set<QueryParameter<?>>
public Set<Parameter<?>>
public boolean
public Set<String>

Returns:

the parameter names, in no particular order
getNamedParameterNames
()

Return the names of all named parameters of the query.

public Collection<QueryParameter<T>>
public int
public int

Returns:

The number of positional parameters.
getPositionalParameterCount
()

Returns the number of positional parameters.

public Collection<QueryParameter<T>>
public <T> QueryParameter<T>
public <T> QueryParameter<T>
public boolean

Returns:

true if there are named parameters; false otherwise.
hasNamedParameters
()

Does this parameter set contain any named parameters?

public boolean

Returns:

true if there are positional parameters; false otherwise.
hasPositionalParameters
()

Does this parameter set contain any positional parameters?

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

public void

Method Detail

collectAllParametersback to summary
public Set<QueryParameter<?>> collectAllParameters()
collectAllParametersJpaback to summary
public Set<Parameter<?>> collectAllParametersJpa()
containsReferenceback to summary
public boolean containsReference(QueryParameter<T> parameter)
getNamedParameterNamesback to summary
public Set<String> getNamedParameterNames()

Return the names of all named parameters of the query.

Returns:Set<String>

the parameter names, in no particular order

getNamedParametersback to summary
public Collection<QueryParameter<T>> getNamedParameters()
getParameterCountback to summary
public int getParameterCount()
getPositionalParameterCountback to summary
public int getPositionalParameterCount()

Returns the number of positional parameters.

Returns:int

The number of positional parameters.

getPositionalParametersback to summary
public Collection<QueryParameter<T>> getPositionalParameters()
getQueryParameterback to summary
public <T> QueryParameter<T> getQueryParameter(String name)
getQueryParameterback to summary
public <T> QueryParameter<T> getQueryParameter(Integer position)
hasNamedParametersback to summary
public boolean hasNamedParameters()

Does this parameter set contain any named parameters?

Returns:boolean

true if there are named parameters; false otherwise.

hasPositionalParametersback to summary
public boolean hasPositionalParameters()

Does this parameter set contain any positional parameters?

Returns:boolean

true if there are positional parameters; false otherwise.

resolveback to summary
public <T> QueryParameter<T> resolve(Parameter<T> param)
visitRegistrationsback to summary
public void visitRegistrations(Consumer<QueryParameter<T>> action)