org.springframework.data.jpa.repository.QueryHints Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spring-data-jpa Show documentation
Show all versions of spring-data-jpa Show documentation
Spring Data module to provide sophisticated support for JPA repositories
/*
* Copyright 2008-2011 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.jpa.repository;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import javax.persistence.QueryHint;
/**
* Wrapper annotation to allow {@link QueryHint} annotations to be bound to methods. It will be evaluated when using
* {@link Query} on a query method or if you derive the query from the method name. If you rely on named queries either
* use the XML or annotation based way to declare {@link QueryHint}s in combination with the actual named query
* declaration.
*
* @author Oliver Gierke
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface QueryHints {
/**
* The {@link QueryHint}s to apply when the query will be executed.
*
* @return
*/
QueryHint[] value() default {};
/**
* Defines whether the configured {@link QueryHint}s shall be applied for count queries during pagination as well.
* Defaults to {@literal true}.
*
* @return
*/
boolean forCounting() default true;
}