Class StaticTypedQueryReference<R>

java.lang.Object

jakarta.persistence.query.StaticTypedQueryReference<R>

Type Parameters:

R - The result type of the query

All Implemented Interfaces:

Reference, TypedQueryReference<R>

public class StaticTypedQueryReference<R>
extends Object
implements TypedQueryReference<R>

A reference to a query declared using a JakartaQuery or NativeQuery annotation. An instance of this class is usually instantiated by a generated method of the static metamodel for the annotated program element.

Since:

4.0

Constructor Summary

Constructors

Constructor	Description
StaticTypedQueryReference(String queryName, Class<?> annotatedClass, String annotatedMemberName, Class<R> resultType, List<Class<?>> parameterTypes, List<String> parameterNames, List<Object> arguments)	Intended for use in code generated by an annotation processor.
StaticTypedQueryReference(String queryName, Class<?> annotatedClass, String annotatedMemberName, Class<R> resultType, List<Class<?>> parameterTypes, List<String> parameterNames, List<Object> arguments, String entityGraphName, Map<String,Object> hints, TypedQuery.Option... options)	Intended for use in code generated by an annotation processor.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Class<?>	getAnnotatedClass()
String	getAnnotatedMemberName()
List<Object>	getArguments()	The arguments supplied to the parameters of the statement or query, or null if no arguments were supplied.
String	getEntityGraphName()	The specified entity graph name, if any, or null if no entity graph was specified.
Map<String,Object>	getHints()	A map keyed by hint name of all hints specified via NamedQuery.hints(), NamedNativeQuery.hints(), or QueryOptions.hints().
String	getName()	The name of the statement or query, as specified by NamedQuery.name() or NamedNativeQuery.name(), or as inferred from the name of the method annotated JakartaQuery or NativeQuery.
Set<TypedQuery.Option>	getOptions()	All options specified by QueryOptions, NamedQuery, or NamedNativeQuery, or an empty set if no options were specified.
List<String>	getParameterNames()	The names assigned to the supplied arguments to parameters of the statement or query, or null if no arguments were supplied.
List<Class<?>>	getParameterTypes()	The types of the supplied arguments to parameters of the statement or query, or null if no arguments were supplied.
Class<? extends R>	getResultType()	The result type of the query, as specified by NamedQuery.resultClass() or NamedNativeQuery.resultClass(), or as inferred from the declared return type of the method annotated JakartaQuery or NativeQuery.
int	hashCode()
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

StaticTypedQueryReference

public StaticTypedQueryReference(String queryName,
 Class<?> annotatedClass,
 String annotatedMemberName,
 Class<R> resultType,
 List<Class<?>> parameterTypes,
 List<String> parameterNames,
 List<Object> arguments,
 String entityGraphName,
 Map<String,Object> hints,
 TypedQuery.Option... options)

Intended for use in code generated by an annotation processor. This constructor overload is adapted to the case where the program element is annotated with QueryOptions.

Parameters:

queryName - The name of the query, the concatenation of the unqualified name of the annotated type, with the string ".", and the name of the annotated member

annotatedClass - The annotated class

annotatedMemberName - The name of the annotated member

resultType - The result type of the query, the type of the annotated member

parameterTypes - The types of the parameters of the annotated member

parameterNames - The names of the parameters of the annotated member

arguments - The arguments supplied to the parameters at runtime

entityGraphName - See QueryOptions.entityGraph()

hints - See QueryOptions.hints()

options - All specified options

StaticTypedQueryReference

public StaticTypedQueryReference(String queryName,
 Class<?> annotatedClass,
 String annotatedMemberName,
 Class<R> resultType,
 List<Class<?>> parameterTypes,
 List<String> parameterNames,
 List<Object> arguments)

Intended for use in code generated by an annotation processor. This constructor overload is adapted to the case where the program element is not annotated with QueryOptions.

Parameters:

queryName - The name of the query, the concatenation of the unqualified name of the annotated type, with the string ".", and the name of the annotated member

annotatedClass - The annotated class

annotatedMemberName - The name of the annotated member

resultType - The result type of the query, the type of the annotated member

parameterTypes - The types of the parameters of the annotated member

parameterNames - The names of the parameters of the annotated member

arguments - The arguments supplied to the parameters at runtime

Method Details

getName

public String getName()

Description copied from interface: Reference

The name of the statement or query, as specified by NamedQuery.name() or NamedNativeQuery.name(), or as inferred from the name of the method annotated JakartaQuery or NativeQuery.

Specified by:

getName in interface Reference

getResultType

public Class<? extends R> getResultType()

Description copied from interface: TypedQueryReference

The result type of the query, as specified by NamedQuery.resultClass() or NamedNativeQuery.resultClass(), or as inferred from the declared return type of the method annotated JakartaQuery or NativeQuery.

Specified by:

getResultType in interface TypedQueryReference<R>

getHints

public Map<String,Object> getHints()

Description copied from interface: Reference

A map keyed by hint name of all hints specified via NamedQuery.hints(), NamedNativeQuery.hints(), or QueryOptions.hints().

Any attempted mutation of the returned map results in an UnsupportedOperationException.

Specified by:

getHints in interface Reference

getParameterTypes

public List<Class<?>> getParameterTypes()

Description copied from interface: Reference

The types of the supplied arguments to parameters of the statement or query, or null if no arguments were supplied. Arguments are present when this is a reference to a statement or query declared using an annotation of a method.

Any mutation of the returned list results in an UnsupportedOperationException.

Specified by:

getParameterTypes in interface Reference

getParameterNames

public List<String> getParameterNames()

Description copied from interface: Reference

The names assigned to the supplied arguments to parameters of the statement or query, or null if no arguments were supplied. Arguments are present when this is a reference to a statement or query declared using an annotation of a method. If the query has named parameters, these are interpreted as the parameter names. Otherwise, if the query has positional parameters, they are ignored.

Any mutation of the returned list results in an UnsupportedOperationException.

Specified by:

getParameterNames in interface Reference

getArguments

public List<Object> getArguments()

Description copied from interface: Reference

The arguments supplied to the parameters of the statement or query, or null if no arguments were supplied. Arguments are present when this is a reference to a query declared using an annotation of a method.

• If the query has ordinal parameters, the position of an argument in this array determines its assignment to a parameter.
• If the query has named parameters, this array is aligned elementwise with the array of parameter names to obtain an assignment of arguments to parameters.

Any mutation of the returned list results in an UnsupportedOperationException.

Specified by:

getArguments in interface Reference

See Also:

• Query.setParameter(int, Object)
• Query.setParameter(String, Object)

getAnnotatedClass

public Class<?> getAnnotatedClass()

getAnnotatedMemberName

public String getAnnotatedMemberName()

getEntityGraphName

public String getEntityGraphName()

Description copied from interface: TypedQueryReference

The specified entity graph name, if any, or null if no entity graph was specified.

Specified by:

getEntityGraphName in interface TypedQueryReference<R>

See Also:

• NamedQuery.entityGraph()
• QueryOptions.entityGraph()

getOptions

public Set<TypedQuery.Option> getOptions()

Description copied from interface: TypedQueryReference

All options specified by QueryOptions, NamedQuery, or NamedNativeQuery, or an empty set if no options were specified.

Specified by:

getOptions in interface TypedQueryReference<R>

See Also:

• TypedQuery.addOption(TypedQuery.Option)
• QueryOptions.cacheStoreMode()
• QueryOptions.cacheRetrieveMode()
• QueryOptions.lockMode()
• QueryOptions.lockScope()
• QueryOptions.timeout()
• QueryOptions.flush()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object