All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.enterprise.inject.spi.ProcessProducer Maven / Gradle / Ivy

There is a newer version: 2.0.SP1
Show newest version
/*
 * 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 javax.enterprise.inject.spi;

/**
 * 

* The container fires an event of this type for each {@linkplain javax.enterprise.inject.Produces producer method or field} of * each enabled bean, including resources. *

*

* Any observer of this event is permitted to wrap and/or replace the {@code Producer}. The container must use the final value * of this property, after all observers have been called, whenever it calls the producer or disposer. *

*

* For example, this observer decorates the {@code Producer} for the all producer methods and field of type * {@code EntityManager}. *

* *
 * void decorateEntityManager(@Observes ProcessProducer<?, EntityManager> pp) {
 *     pit.setProducer(decorate(pp.getProducer()));
 * }
 * 
*

* If any observer method of a {@code ProcessProducer} event throws an exception, the exception is treated as a definition error * by the container. *

* * @see Producer * @author David Allen * @param The bean class of the bean that declares the producer method or field * @param The return type of the producer method or the type of the producer field */ public interface ProcessProducer { /** * Returns the {@link javax.enterprise.inject.spi.AnnotatedField} representing the producer field or the * {@link javax.enterprise.inject.spi.AnnotatedMethod} representing the producer method. * * @return the {@link javax.enterprise.inject.spi.AnnotatedMember} representing the producer * @throws IllegalStateException if called outside of the observer method invocation */ public AnnotatedMember getAnnotatedMember(); /** * Returns the {@link javax.enterprise.inject.spi.Producer} object that will be used by the container to call the producer * method or read the producer field. * * @return the {@link javax.enterprise.inject.spi.Producer} invoker object used by the container * @throws IllegalStateException if called outside of the observer method invocation */ public Producer getProducer(); /** * Replaces the {@link javax.enterprise.inject.spi.Producer} object that will be used by the container to call the producer * method or read the producer field. * * @param producer the new {@link javax.enterprise.inject.spi.Producer} object to use * @throws IllegalStateException if called outside of the observer method invocation */ public void setProducer(Producer producer); /** * Registers a definition error with the container, causing the container to abort deployment after bean discovery is * complete. * * @param t The definition error to register as a {@link java.lang.Throwable} * @throws IllegalStateException if called outside of the observer method invocation */ public void addDefinitionError(Throwable t); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy