javax.enterprise.inject.spi.Producer Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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;
import java.util.Set;
import javax.enterprise.context.spi.CreationalContext;
/**
* Provides a generic operation for producing an instance of a type.
*
* @version $Rev: 1796153 $ $Date: 2017-05-25 11:09:15 -0400 (Thu, 25 May 2017) $
*
* bean type
*/
public interface Producer
{
/**
* Its result depends on bean type.
*
*
*
*
*
* - Bean Class : It calls the constructor annotated with {@link javax.inject.Inject} if it
* exists, or the constructor with no parameters otherwise.
*
* - Producer Method or Field : Calls the producer method on,
* or accesses the producer field of, a contextual instance of the most
* specialized bean that specializes the bean that declares the producer method
*
*
*
*
* @param creationalContext creational context
*
* @return an instance of bean
*/
T produce(CreationalContext creationalContext);
/**
* Its result depends on bean type.
*
*
* - Bean Class : Does nothing.
* - Producer Method : Calls disposer method or any other cleanup.
*
*
*
* @param instance dispose instance
*/
void dispose(T instance);
/**
* Its result depends on bean type.
*
*
*
*
* - Bean Class : Returns the set of InjectionPoint objects representing all injected fields,
* bean constructor parameters and initializer method parameters.
*
* - Producer Method : Returns the set of InjectionPoint objects
* representing all parameters of the producer method.
*
*
*
*
*
* @return set of injection points
*/
Set getInjectionPoints();
}