org.hibernate.service.spi.InjectService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation

Hibernate's core ORM functionality

There is a newer version: 7.0.0.Alpha1

/*
 * 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.service.spi;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

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

/**
 * Annotation to allow services to request injection of other services
 *
 * @author Steve Ebersole
 */
@Target(METHOD)
@Retention(RUNTIME)
public @interface InjectService {
	/**
	 * The service role to inject, the default is to use the type of the parameter to which this method is
	 * attached.
	 *
	 * @return The service role.
	 */
	public Class serviceRole() default Void.class;

	/**
	 * Is the service to be injected required (not optional)?
	 *
	 * @return True if the service is required.
	 */
	public boolean required() default true;
}