javax.enterprise.inject.spi.ProcessProducerField 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 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 enabled producer field, before registering the
 * {@link javax.enterprise.inject.spi.Bean} object. Resources are considered to be producer fields.
 * 
 * 
 * If any observer method of a {@code ProcessProducerField} event throws an exception, the exception is treated as a definition
 * error by the container.
 * 
 * 
 * @author David Allen
 * @param  The type of the producer field
 * @param  The class of the bean declaring the producer field
 * 
 */
public interface ProcessProducerField extends ProcessBean {
    /**
     * Returns the {@link javax.enterprise.inject.spi.AnnotatedField} representing the producer field.
     * 
     * @return the {@link javax.enterprise.inject.spi.AnnotatedField} for the producer field being registered
     * @throws IllegalStateException if called outside of the observer method invocation
     */
    public AnnotatedField getAnnotatedProducerField();

    /**
     * Returns the {@link javax.enterprise.inject.spi.AnnotatedParameter} for any matching injection point of the same type as
     * the producer field return type found on a disposal method.
     * 
     * @return the disposal method's {@link javax.enterprise.inject.spi.AnnotatedParameter}
     * @throws IllegalStateException if called outside of the observer method invocation
     * @since 1.1
     */
    public AnnotatedParameter getAnnotatedDisposedParameter();
}