javax.enterprise.inject.spi.configurator.ProducerConfigurator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cdi-api Show documentation
APIs for CDI (Contexts and Dependency Injection for Java EE)
There is a newer version: 2.0.SP1
/*
 * JBoss, Home of Professional Open Source
 * Copyright 2016, 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 javax.enterprise.inject.spi.configurator;

import java.util.Set;
import java.util.function.Consumer;
import java.util.function.Function;

import javax.enterprise.context.spi.CreationalContext;
import javax.enterprise.inject.spi.InjectionPoint;
import javax.enterprise.inject.spi.ProcessProducer;
import javax.enterprise.inject.spi.Producer;

/**
 * 
 * A {@link ProducerConfigurator} can configure a {@link Producer}. The container must provide an implementation of this
 * interface.
 * 
 * 
 * 
 * This configurator is not thread safe and shall not be used concurrently.
 * 
 *
 * @param  The return type of the producer method or the type of the producer field
 * @author Martin Kouba
 * @see ProcessProducer#configureObserverMethod()
 * @since 2.0
 */
public interface ProducerConfigurator {

    /**
     * Set a callback to produce a new instance.
     * 
     * @param callback
     * @return self
     * @see Producer#produce(CreationalContext)
     */
     ProducerConfigurator produceWith(Function, U> callback);

    /**
     * Set a callback to destroy the produced instance.
     * 
     * @param callback
     * @return self
     * @see Producer#dispose(Object)
     */
    ProducerConfigurator disposeWith(Consumer callback);

    /**
     * Add an injection point to the configured producer.
     *
     * @param injectionPoint the injectionPoint to add
     * @return self
     */
    ProducerConfigurator addInjectionPoint(InjectionPoint injectionPoint);

    /**
     * Add injection points to the configured producer.
     *
     * @param injectionPoints the injectionPoints to add
     * @return self
     */
    ProducerConfigurator addInjectionPoints(InjectionPoint... injectionPoints);

    /**
     * Add injection points to the configured producer.
     *
     * @param injectionPoints the injectionPoints to add
     * @return self
     */
    ProducerConfigurator addInjectionPoints(Set injectionPoints);

    /**
     * Replace injection points for the configured producer.
     *
     * @param injectionPoints the injectionPoints for the configured bean
     * @return self
     */
    ProducerConfigurator injectionPoints(InjectionPoint... injectionPoints);

}