Jakarta Persistence (JPA) Interface

jakarta.persistence.Parameter<T>

Type Parameters:
<T> - the type of the parameter
Type for query parameter objects.
See Also:
Since:
Jakarta Persistence (JPA) 2.0
Chapter 4 - JPA Queries (JPQL / Criteria) explains how to use Parameter.

Public Instance Methods

String getName()
Return the parameter name, or null if the parameter is not a named parameter or no name has been assigned.
Returns:
parameter name.
Since:
Jakarta Persistence (JPA) 1.0
Class<T> 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:
the Java type of the parameter.
Throws:
IllegalStateException - if invoked on a parameter obtained from a query language query or native query when the implementation does not support this usage.
Since:
Jakarta Persistence (JPA) 1.0
Integer getPosition()
Return the parameter position, or null if the parameter is not a positional parameter.
Returns:
position of parameter.
Since:
Jakarta Persistence (JPA) 1.0