-
- Type Parameters:
T
- the type of the parameter
- All Known Subinterfaces:
- ParameterExpression<T>
public interface Parameter<T>
Type for query parameter objects.- Since:
- Java Persistence 2.0
- See Also:
Query
,TypedQuery
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description String
getName()
Return the parameter name, or null if the parameter is not a named parameter or no name has been assigned.Class<T>
getParameterType()
Return the Java type of the parameter.Integer
getPosition()
Return the parameter position, or null if the parameter is not a positional parameter.
-
-
-
Method Detail
-
getName
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
-
getPosition
Integer getPosition()
Return the parameter position, or null if the parameter is not a positional parameter.- Returns:
- position of parameter
-
getParameterType
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 Java 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 Java persistence query language query or native query when the implementation does not support this use
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/persistence/Parameter.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.