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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javaee-api Show documentation
There is a newer version: 8.0-6
/*
 * 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 javax.enterprise.inject.spi.configurator.BeanAttributesConfigurator;

/**
 * Each {@link AnnotatedType} gets scanned by the CDI container and turned
 * into initial {@link BeanAttributes}. Those BeanAttributes can be modified
 * by observing this very ProcessBeanAttributes system event.
 * The modified BeanAttributes will get used to construct the final {@link Bean}.
 *
 */
public interface ProcessBeanAttributes
{
    /**
     * @return the {@link AnnotatedType} for bean classes, {@link AnnotatedMethod} for producer methods and
     *          {@link AnnotatedField} for producer fields.
     */
    Annotated getAnnotated();

    /**
     * @return the BeanAttributes parsed from the {@link Annotated}
     */
    BeanAttributes getBeanAttributes();

    /**
     * Use the given BeanAttributes to later create the {@link Bean} from it.
     * @param beanAttributes
     */
    void setBeanAttributes(BeanAttributes beanAttributes);

    /**
     * Tell the container it should ignore this Bean.
     */
    void veto();

    /**
     * Adding definition error. Container aborts
     * processing after calling all observers.
     *
     * @param t throwable
     */
    void addDefinitionError(Throwable t);

    /**
     * Usually having a non-static final field with any modifier other than private leads to a
     * DeploymentException. This is to prevent user failures as those fields cannot be proxied.
     *
     * In certain situations one want's to provide a CDI bean for such a class nonetheless.
     * By invoking this method on a Bean wich such a class we can effectively prevent the container
     * from treating this situation as a Deployment error.
     */
    void ignoreFinalMethods();

   /**
    * @return a bean attributes configurator to configure this bean's attributes.
    *       It is initialised with the BeanAttributes from the event which gets processed.
    */
    BeanAttributesConfigurator configureBeanAttributes();
}