Top Description Methods
javax.persistence

public Interface Parameter<T>

Known Direct Subinterfaces
javax.persistence.criteria.ParameterExpression
Type Parameters
<T>
the type of the parameter

Type for query parameter objects.
Since
Java Persistence 2.0
See Also
Query, TypedQuery

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

parameter name
getName
()

Return the parameter name, or null if the parameter is not a named parameter or no name has been assigned.

public Class<T>

Returns:

the Java type of the parameter
getParameterType
()

Return the Java type of the parameter.

public Integer

Returns:

position of parameter
getPosition
()

Return the parameter position, or null if the parameter is not a positional parameter.

Method Detail

getNameback to summary
public String getName()

Return the parameter name, or null if the parameter is not a named parameter or no name has been assigned.

Returns:String

parameter name

getParameterTypeback to summary
public 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:Class<T>

the Java type of the parameter

Exceptions
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
getPositionback to summary
public Integer getPosition()

Return the parameter position, or null if the parameter is not a positional parameter.

Returns:Integer

position of parameter