javax.enterprise.inject.spi.ProcessObserverMethod 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.ObserverMethodConfigurator;

/**
 * Fired for each observer.
 * 
 * @version $Rev: 1806725 $ $Date: 2017-08-30 15:23:59 -0400 (Wed, 30 Aug 2017) $
 *
 * @param  observed event type
 * @param  bean class
 */
public interface ProcessObserverMethod
{
    /**
     * Returns annotated method.
     * 
     * @return annotated method
     */
    AnnotatedMethod getAnnotatedMethod();
    
    /**
     * Returns observer method instance that
     * is called by the container on event. 
     * 
     * @return observer method instance
     */
    ObserverMethod getObserverMethod();


    /**
     * @param observerMethod to replace the original one
     * @since 2.0
     */
    void setObserverMethod(ObserverMethod observerMethod);

    /**
     * Tell the container to ignore the current ObserverMethod.
     */
    void veto();

    /**
     * Add throwable.
     * 
     * @param t throwable
     */
    void addDefinitionError(Throwable t);

   /**
    * Creates a configurator for this observer method.
    * It is initialised with the information from the currently
    * processed ObserverMethod
    *
    * @return an {@code ObserverMethodConfigurator} to tweak the processed Observermethod
    */
    ObserverMethodConfigurator configureObserverMethod();


    
}