Interface Parameter<T>

  • Type Parameters:
    T - the type of the parameter
    All Known Subinterfaces:
    ParameterExpression<T>

    public interface Parameter<T>
    Type for query parameter objects.
    See Also:
    Query, TypedQuery
    Since:
    2.0
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getName()
      Return the parameter name, or null if the parameter is not a named parameter or no name has been assigned.
      java.lang.Class<T> getParameterType()
      Return the Java type of the parameter.
      java.lang.Integer getPosition()
      Return the parameter position, or null if the parameter is not a positional parameter.
    • Method Detail

      • getName

        java.lang.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

        java.lang.Integer getPosition()
        Return the parameter position, or null if the parameter is not a positional parameter.
        Returns:
        position of parameter
      • getParameterType

        java.lang.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:
        java.lang.IllegalStateException - if invoked on a parameter obtained from a query language query or native query when the implementation does not support this use