jakarta.enterprise.inject.spi.Producer Maven / Gradle / Ivy
/*
* 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.util.Set;
import jakarta.enterprise.context.spi.CreationalContext;
/**
*
* Provides a generic operation for producing an instance of a type.
*
*
* CDI Lite implementations are not required to provide support for {@code Producer}.
*
* @author Pete Muir
* @author David Allen
* @param The class of object produced by the producer
*/
public interface Producer {
/**
*
* Causes an instance to be produced via the {@code Producer}.
*
*
* If the {@code Producer} represents a class, this will invoke the constructor annotated {@link jakarta.inject.Inject} if it
* exists, or the constructor with no parameters otherwise. If the class has interceptors, produce() is responsible
* for building the interceptors and decorators of the instance.
*
*
* If the {@code Producer} represents a producer field or method, this will invoke the producer method on, or access the
* producer field of, a contextual instance of the bean that declares the producer.
*
*
* @param ctx The {@link CreationalContext} to use for the produced object
* @return the instance produced
*/
public T produce(CreationalContext ctx);
/**
*
* Destroys the instance.
*
*
* If the {@code Producer} represents a class, then this operation does nothing.
*
*
* If the {@code Producer} represents a producer field or method, this calls the disposer method, if any, on a contextual
* instance of the bean that declares the disposer method or performs any additional required cleanup, if any, to destroy
* state associated with a resource.
*
*
* @param instance The instance to dispose
*/
public void dispose(T instance);
/**
*
* Returns the set of all {@code InjectionPoints}. If the {@code Producer} represents a class, then this returns returns the
* set of {@code InjectionPoint} objects representing all injected fields, bean constructor parameters and initializer
* method parameters. For a producer method, this returns the set of {@code InjectionPoint} objects representing all
* parameters of the producer method.
*
*
* @return the set of all {@linkplain InjectionPoint injection points} for the producer
*/
public Set getInjectionPoints();
}