Top Description Fields Constructors Methods
org.hibernate.procedure.internal

public Class ProcedureParameterMetadataImpl

extends Object
implements ProcedureParameterMetadataImplementor
Class Inheritance
All Implemented Interfaces
org.hibernate.query.spi.ProcedureParameterMetadataImplementor, org.hibernate.query.spi.ParameterMetadataImplementor, org.hibernate.query.ParameterMetadata
Imports
java.util.ArrayList, .Collections, .HashSet, .List, .Set, java.util.function.Consumer, .Predicate, java.util.stream.Collectors, jakarta.persistence.Parameter, org.hibernate.engine.spi.SharedSessionContractImplementor, org.hibernate.procedure.spi.NamedCallableQueryMemento, .ParameterStrategy, .ProcedureParameterImplementor, org.hibernate.query.QueryParameter, org.hibernate.query.procedure.ProcedureParameter, org.hibernate.query.spi.ProcedureParameterMetadataImplementor, .QueryParameterImplementor
Specialized ParameterMetadataImplementor for callable queries implementing expandable parameter registrations
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private List<ProcedureParameterImplementor<?>>
parameters

private ParameterStrategy
parameterStrategy

Constructor Summary

AccessConstructor and Description
public
ProcedureParameterMetadataImpl()

public
ProcedureParameterMetadataImpl(NamedCallableQueryMemento memento, SharedSessionContractImplementor session)

Method Summary

Modifier and TypeMethod and Description
public boolean
containsReference(QueryParameter<T> parameter)

Implements org.hibernate.query.ParameterMetadata.containsReference.

Is this parameter reference registered in this collection?
public ProcedureParameterImplementor<?>
findQueryParameter(String name)

Implements org.hibernate.query.spi.ParameterMetadataImplementor.findQueryParameter.

Find the QueryParameter registered under the given name, if one.
public ProcedureParameterImplementor<?>
findQueryParameter(int positionLabel)

Implements org.hibernate.query.spi.ParameterMetadataImplementor.findQueryParameter.

Find the QueryParameter registered under the given position-label, if one.
public Set<String>
getNamedParameterNames()

Implements org.hibernate.query.ParameterMetadata.getNamedParameterNames.

Return the names of all named parameters of the query.
public Set<Integer>
getOrdinalParameterLabels()

Implements org.hibernate.query.ParameterMetadata.getOrdinalParameterLabels.

public int
getParameterCount()

Implements org.hibernate.query.ParameterMetadata.getParameterCount.

The total number of registered parameters.
public ParameterStrategy
getParameterStrategy()

public ProcedureParameterImplementor<?>
getQueryParameter(String name)

Implements org.hibernate.query.spi.ParameterMetadataImplementor.getQueryParameter.

Get the QueryParameter reference registered here under the given name.
public ProcedureParameterImplementor<?>
getQueryParameter(int positionLabel)

Implements org.hibernate.query.spi.ParameterMetadataImplementor.getQueryParameter.

Get the QueryParameter reference registered here under the given position-label.
public Set<? extends QueryParameter<?>>
getRegistrations()

Implements org.hibernate.query.ParameterMetadata.getRegistrations.

public List<? extends ProcedureParameterImplementor<?>>
getRegistrationsAsList()

Implements org.hibernate.query.spi.ProcedureParameterMetadataImplementor.getRegistrationsAsList.

public boolean
hasAnyMatching(Predicate<QueryParameterImplementor<?>> filter)

Implements org.hibernate.query.spi.ParameterMetadataImplementor.hasAnyMatching.

public boolean
hasNamedParameters()

Implements org.hibernate.query.ParameterMetadata.hasNamedParameters.

Does this parameter set contain any named parameters?
public boolean
hasPositionalParameters()

Implements org.hibernate.query.ParameterMetadata.hasPositionalParameters.

Does this parameter set contain any positional parameters?
public void
registerParameter(ProcedureParameterImplementor<T> parameter)

public <P> ProcedureParameterImplementor<P>
resolve(Parameter<P> param)

Implements org.hibernate.query.spi.ParameterMetadataImplementor.resolve.

A deeper resolution attempt from a JPA parameter reference to Hibernate's contract.
public void
visitParameters(Consumer<QueryParameterImplementor<?>> consumer)

Implements org.hibernate.query.spi.ParameterMetadataImplementor.visitParameters.

public void
visitRegistrations(Consumer<? extends QueryParameter<?>> action)

Overrides default org.hibernate.query.spi.ParameterMetadataImplementor.visitRegistrations.

General purpose visitation using functional
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

parametersback to summary
private List<ProcedureParameterImplementor<?>> parameters
parameterStrategyback to summary
private ParameterStrategy parameterStrategy

Constructor Detail

ProcedureParameterMetadataImplback to summary
public ProcedureParameterMetadataImpl()
ProcedureParameterMetadataImplback to summary
public ProcedureParameterMetadataImpl(NamedCallableQueryMemento memento, SharedSessionContractImplementor session)

Method Detail

containsReferenceback to summary
public boolean containsReference(QueryParameter<T> parameter)

Implements org.hibernate.query.ParameterMetadata.containsReference.

Doc from org.hibernate.query.ParameterMetadata.containsReference.

Is this parameter reference registered in this collection?

Annotations
@Override
@SuppressWarnings:SuspiciousMethodCalls
findQueryParameterback to summary
public ProcedureParameterImplementor<?> findQueryParameter(String name)

Implements org.hibernate.query.spi.ParameterMetadataImplementor.findQueryParameter.

Doc from org.hibernate.query.ParameterMetadata.findQueryParameter.

Find the QueryParameter registered under the given name, if one.

Returns:ProcedureParameterImplementor<?>

The registered match, or null is there is no match

Annotations
@Override
findQueryParameterback to summary
public ProcedureParameterImplementor<?> findQueryParameter(int positionLabel)

Implements org.hibernate.query.spi.ParameterMetadataImplementor.findQueryParameter.

Doc from org.hibernate.query.ParameterMetadata.findQueryParameter.

Find the QueryParameter registered under the given position-label, if one.

Returns:ProcedureParameterImplementor<?>

The registered match, or null is there is no match

Annotations
@Override
getNamedParameterNamesback to summary
public Set<String> getNamedParameterNames()

Implements org.hibernate.query.ParameterMetadata.getNamedParameterNames.

Doc from org.hibernate.query.ParameterMetadata.getNamedParameterNames.

Return the names of all named parameters of the query.

Returns:Set<String>

the parameter names

Annotations
@Override
getOrdinalParameterLabelsback to summary
public Set<Integer> getOrdinalParameterLabels()

Implements org.hibernate.query.ParameterMetadata.getOrdinalParameterLabels.

Annotations
@Override
getParameterCountback to summary
public int getParameterCount()

Implements org.hibernate.query.ParameterMetadata.getParameterCount.

Doc from org.hibernate.query.ParameterMetadata.getParameterCount.

The total number of registered parameters.

Annotations
@Override
getParameterStrategyback to summary
public ParameterStrategy getParameterStrategy()
getQueryParameterback to summary
public ProcedureParameterImplementor<?> getQueryParameter(String name)

Implements org.hibernate.query.spi.ParameterMetadataImplementor.getQueryParameter.

Doc from org.hibernate.query.ParameterMetadata.getQueryParameter.

Get the QueryParameter reference registered here under the given name.

Returns:ProcedureParameterImplementor<?>

The registered match. Never null

Annotations
@Override
getQueryParameterback to summary
public ProcedureParameterImplementor<?> getQueryParameter(int positionLabel)

Implements org.hibernate.query.spi.ParameterMetadataImplementor.getQueryParameter.

Doc from org.hibernate.query.ParameterMetadata.getQueryParameter.

Get the QueryParameter reference registered here under the given position-label.

Returns:ProcedureParameterImplementor<?>

The registered match. Never null

Annotations
@Override
getRegistrationsback to summary
public Set<? extends QueryParameter<?>> getRegistrations()

Implements org.hibernate.query.ParameterMetadata.getRegistrations.

Annotations
@Override
getRegistrationsAsListback to summary
public List<? extends ProcedureParameterImplementor<?>> getRegistrationsAsList()

Implements org.hibernate.query.spi.ProcedureParameterMetadataImplementor.getRegistrationsAsList.

Annotations
@Override
hasAnyMatchingback to summary
public boolean hasAnyMatching(Predicate<QueryParameterImplementor<?>> filter)

Implements org.hibernate.query.spi.ParameterMetadataImplementor.hasAnyMatching.

Annotations
@Override
hasNamedParametersback to summary
public boolean hasNamedParameters()

Implements org.hibernate.query.ParameterMetadata.hasNamedParameters.

Doc from org.hibernate.query.ParameterMetadata.hasNamedParameters.

Does this parameter set contain any named parameters?

Returns:boolean

true if there are named parameters; false otherwise.

Annotations
@Override
hasPositionalParametersback to summary
public boolean hasPositionalParameters()

Implements org.hibernate.query.ParameterMetadata.hasPositionalParameters.

Doc from org.hibernate.query.ParameterMetadata.hasPositionalParameters.

Does this parameter set contain any positional parameters?

Returns:boolean

true if there are positional parameters; false otherwise.

Annotations
@Override
registerParameterback to summary
public void registerParameter(ProcedureParameterImplementor<T> parameter)
resolveback to summary
public <P> ProcedureParameterImplementor<P> resolve(Parameter<P> param)

Implements org.hibernate.query.spi.ParameterMetadataImplementor.resolve.

Doc from org.hibernate.query.ParameterMetadata.resolve.

A deeper resolution attempt from a JPA parameter reference to Hibernate's contract. Generally should return the same param reference. According to the spec, only Parameter references obtained from the provider are valid.

Annotations
@Override
visitParametersback to summary
public void visitParameters(Consumer<QueryParameterImplementor<?>> consumer)

Implements org.hibernate.query.spi.ParameterMetadataImplementor.visitParameters.

Annotations
@Override
visitRegistrationsback to summary
public void visitRegistrations(Consumer<? extends QueryParameter<?>> action)

Overrides default org.hibernate.query.spi.ParameterMetadataImplementor.visitRegistrations.

Doc from org.hibernate.query.ParameterMetadata.visitRegistrations.

General purpose visitation using functional

Annotations
@Override