Module jakarta.cdi
Package jakarta.enterprise.inject.spi

Interface ProcessObserverMethod<T,​X>

  • Type Parameters:
    T - The type of the event being observed
    X - The bean type containing the observer method
    All Known Subinterfaces:
    ProcessSyntheticObserverMethod<T,​X>
    public interface ProcessObserverMethod<T,​X>

    The container fires an event of this type for each observer method of each enabled bean, before registering the ObserverMethod object.

    For a custom implementation of ObserverMethod, the container must raise an event of type ProcessSyntheticObserverMethod.

    Any observer of this event is permitted to wrap and/or replace the ObserverMethod by calling either setObserverMethod(ObserverMethod) or configureObserverMethod(). If both methods are called within an observer notification an IllegalStateException is thrown. The container must use the final value of this property, after all observers have been called, he container must use the final value of this property, after all observers have been called, whenever it performs observer resolution.

    If any observer method of a ProcessObserverMethod event throws an exception, the exception is treated as a definition error by the container.

    CDI Lite implementations are not required to provide support for Portable Extensions.

    Author:
    Gavin King, David Allen, Antoine Sabot-Durand
    See Also:
    ObserverMethod

    • Method Detail

      • getAnnotatedMethod

        AnnotatedMethod<X> getAnnotatedMethod()
        The AnnotatedMethod representing the observer method.

        If invoked upon a ProcessSyntheticObserverMethod event, non-portable behavior results and the returned value should be ignored.

        Returns:
        the AnnotatedMethod representing the observer method
        Throws:
        java.lang.IllegalStateException - if called outside of the observer method invocation

      • getObserverMethod

        ObserverMethod<T> getObserverMethod()
        The ObserverMethod object that will be used by the container to invoke the observer when a matching event is fired.
        Returns:
        the ObserverMethod object that will be used by the container to call the observer method
        Throws:
        java.lang.IllegalStateException - if called outside of the observer method invocation

      • addDefinitionError

        void addDefinitionError​(java.lang.Throwable t)
        Registers a definition error with the container, causing the container to abort deployment after bean discovery is complete.
        Parameters:
        t - A Throwable representing the definition error
        Throws:
        java.lang.IllegalStateException - if called outside of the observer method invocation

      • setObserverMethod

        void setObserverMethod​(ObserverMethod<T> observerMethod)
        Replaces the ObserverMethod.
        Parameters:
        observerMethod - the new ObserverMethod object to use
        Throws:
        java.lang.IllegalStateException - if called outside of the observer method invocation
        Since:
        2.0

      • configureObserverMethod

        ObserverMethodConfigurator<T> configureObserverMethod()
        Returns a ObserverMethodConfigurator initialized with the ObserverMethod processed by this event, to configure a new ObserverMethod that will replace the original one at the end of the observer invocation. Each call returns the same ObserverMethodConfigurator
        Returns:
        a non reusable ObserverMethodConfigurator to configure the replacing ObserverMethod
        Throws:
        java.lang.IllegalStateException - if called outside of the observer method invocation
        Since:
        2.0

      • veto

        void veto()
        Forces the container to ignore the observer method.
        Throws:
        java.lang.IllegalStateException - if called outside of the observer method invocation
        Since:
        2.0