jakarta.enterprise.inject.spi.InjectionPoint Maven / Gradle / Ivy
Show all versions of jakarta.enterprise.cdi-api Show documentation
/*
* JBoss, Home of Professional Open Source
* Copyright 2010, Red Hat, Inc., and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* 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 jakarta.enterprise.inject.spi;
import java.lang.annotation.Annotation;
import java.lang.reflect.Member;
import java.lang.reflect.Type;
import java.util.Set;
import jakarta.enterprise.event.Observes;
import jakarta.enterprise.inject.Disposes;
import jakarta.enterprise.inject.Instance;
import jakarta.enterprise.context.Dependent;
import jakarta.enterprise.inject.Produces;
/**
*
* Provides access to metadata about an injection point. May represent an {@linkplain jakarta.inject.Inject injected field} or a
* parameter of a {@linkplain jakarta.inject.Inject bean constructor}, {@linkplain jakarta.inject.Inject initializer method},
* {@linkplain Produces producer method}, {@linkplain Disposes disposer method}
* or {@linkplain Observes observer method}.
*
*
*
* If the injection point is a dynamically selected reference obtained then the metadata obtain reflects the injection point of
* the {@link Instance}, with the required type and any additional required qualifiers defined by {@linkplain Instance
* Instance.select()}.
*
*
*
* Occasionally, a bean with scope {@link Dependent @Dependent} needs to access metadata relating
* to the object to which it belongs. The bean may inject an {@code InjectionPoint} representing the injection point into which
* the bean was injected.
*
*
*
* For example, the following producer method creates injectable Logger s. The log category of a Logger
* depends upon the class of the object into which it is injected.
*
*
*
* @Produces
* Logger createLogger(InjectionPoint injectionPoint) {
* return Logger.getLogger(injectionPoint.getMember().getDeclaringClass().getName());
* }
*
*
*
* Only {@linkplain Dependent dependent} objects, may obtain information about the injection point to
* which they belong.
*
*
* @author Gavin King
* @author Pete Muir
*/
public interface InjectionPoint {
/**
* Get the required type of injection point.
*
* @return the required type
*/
public Type getType();
/**
* Get the required qualifiers of the injection point.
*
* @return the required qualifiers
*/
public Set getQualifiers();
/**
* Get the {@link Bean} object representing the bean that defines the injection point. If the
* injection point does not belong to a bean, return a null value.
*
* @return the {@link Bean} object representing bean that defines the injection point, of null
* if the injection point does not belong to a bean
*/
public Bean getBean();
/**
* Get the {@link java.lang.reflect.Field} object in the case of field injection, the {@link java.lang.reflect.Method}
* object in the case of method parameter injection or the {@link java.lang.reflect.Constructor} object in the case of
* constructor parameter injection.
*
* @return the member
*/
public Member getMember();
/**
* Obtain an instance of {@link AnnotatedField} or
* {@link AnnotatedParameter}, depending upon whether the injection point is an injected field
* or a constructor/method parameter.
*
* @return an {@code AnnotatedField} or {@code AnnotatedParameter}
*/
public Annotated getAnnotated();
/**
* Determines if the injection point is a decorator delegate injection point.
*
* @return true if the injection point is a decorator delegate injection point, and false otherwise
*/
public boolean isDelegate();
/**
* Determines if the injection is a transient field.
*
* @return true if the injection point is a transient field, and false otherwise
*/
public boolean isTransient();
}