org.hibernate.query.QueryParameter Maven / Gradle / Ivy
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later.
* See the lgpl.txt file in the root directory or .
*/
package org.hibernate.query;
import org.hibernate.Incubating;
import org.hibernate.type.Type;
/**
* NOTE: Consider this contract (and its sub-contracts) as incubating as we transition to 6.0 and SQM
*
* @author Steve Ebersole
*/
@Incubating
public interface QueryParameter extends javax.persistence.Parameter {
/**
* Get the Hibernate Type associated with this parameter.
*
* @return The Hibernate Type.
*/
Type getType();
/**
* JPA has a different definition of positional parameters than what legacy Hibernate HQL had. In JPA,
* the parameter holders are labelled (named :/). At any rate the semantics are different and we often
* need to understand which we are dealing with (and applications might too).
*
* @return {@code true} if this is a JPA-style positional parameter; {@code false} would indicate
* we have either a named parameter ({@link #getName()} would return a non-{@code null} value) or a native
* Hibernate positional parameter.
*/
boolean isJpaPositionalParameter();
// todo : add a method indicating whether this parameter is valid for use in "parameter list binding"
}