jakarta.enterprise.inject.spi.InjectionTargetFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.enterprise.cdi-api Show documentation
APIs for CDI (Contexts and Dependency Injection for Java)
The newest version!
/*
 * Copyright 2013, Red Hat, Inc., and 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 jakarta.enterprise.inject.spi.configurator.AnnotatedTypeConfigurator;

/**
 * 
 * An {@link InjectionTargetFactory} can create an {@link InjectionTarget} for a given bean.
 * 
 *
 * 
 * The {@link InjectionTargetFactory} obtained from {@link BeanManager#getInjectionTargetFactory(AnnotatedType)} is capable of
 * providing container created injection targets. This factory can be wrapped to add behavior to container created injection
 * targets.
 * 
 *
 * 
 * For example:
 * 
 *
 *  * BeanAttributes<MyBean> myBeanAttributes = beanManager.createBeanAttributes(myBeanAnnotatedType);
 * beanManager.createBean(myBeanAttributes, MyBean.class, new InjectionTargetFactory() {
 *
 *     public <T> InjectionTarget<T> createInjectionTarget(Bean<T> bean) {
 *         return new WrappingInjectionTarget<T>(
 *                 beanManager.getInjectionTargetFactory(myBeanAnnotatedType)
 *                         .createInjectionTarget(bean));
 *     }
 * });
 * 
 *
 * 
 * CDI Lite implementations are not required to provide support for {@code InjectionTargetFactory}.
 * 
 *
 * @author Pete Muir
 * @author Antoine Sabot-Durand
 * @since 1.1
 *
 * @param  type on which this InjectionTarget operates
 */
public interface InjectionTargetFactory {

    /**
     * Create a new injection target for a bean.
     *
     * @param bean the bean to create the injection target for, or null if creating a non-contextual object
     * @return the injection target
     */
    public InjectionTarget createInjectionTarget(Bean bean);

    /**
     *
     * Returns an {@link AnnotatedTypeConfigurator} to to configure the {@link AnnotatedType} used to create the
     * {@link InjectionTarget}.
     *
     * Each call returns the same AnnotatedTypeConfigurator.
     *
     * @return an {@link AnnotatedTypeConfigurator} to configure injection points
     * @throws IllegalStateException if used after {@link #createInjectionTarget(Bean)} invocation
     * @since 2.0
     */
    public default AnnotatedTypeConfigurator configure() {
        throw new UnsupportedOperationException("Configuration not supported here");
    }

}