uk.dansiviter.cdi.repos.annotations.Query Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cdi-repos Show documentation

The newest version!

/*
 * Copyright 2023 Daniel Siviter
 *
 * 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 uk.dansiviter.cdi.repos.annotations;

import static java.lang.annotation.ElementType.METHOD;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import jakarta.persistence.NamedNativeQuery;
import jakarta.persistence.NamedQuery;

/**
 * Defines the {@link NamedQuery} or {@link NamedNativeQuery} to use.
 */
@Target(METHOD)
@Retention(RUNTIME)
public @interface Query {
	/**
	 * @return the name of the {@link NamedQuery} or {@link NamedNativeQuery}.
	 */
	String value();

	/**
	 * @return if this is to use named parameters over positional.
	 */
	boolean namedParameters() default false;
}