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 ObserverMethodobject.For a custom implementation of ObserverMethod, the container must raise an event of typeProcessSyntheticObserverMethod.Any observer of this event is permitted to wrap and/or replace the ObserverMethodby calling eithersetObserverMethod(ObserverMethod)orconfigureObserverMethod(). If both methods are called within an observer notification anIllegalStateExceptionis 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 ProcessObserverMethodevent 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 SummaryAll Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddDefinitionError(Throwable t)Registers a definition error with the container, causing the container to abort deployment after bean discovery is complete.ObserverMethodConfigurator<T>configureObserverMethod()Returns aObserverMethodConfiguratorinitialized with theObserverMethodprocessed by this event, to configure a new ObserverMethod that will replace the original one at the end of the observer invocation.AnnotatedMethod<X>getAnnotatedMethod()TheAnnotatedMethodrepresenting the observer method.ObserverMethod<T>getObserverMethod()TheObserverMethodobject that will be used by the container to invoke the observer when a matching event is fired.voidsetObserverMethod(ObserverMethod<T> observerMethod)Replaces theObserverMethod.voidveto()Forces the container to ignore the observer method.
 
- 
- 
- 
Method Detail- 
getAnnotatedMethodAnnotatedMethod<X> getAnnotatedMethod() TheAnnotatedMethodrepresenting the observer method.If invoked upon a ProcessSyntheticObserverMethodevent, non-portable behavior results and the returned value should be ignored.- Returns:
- the AnnotatedMethodrepresenting the observer method
- Throws:
- IllegalStateException- if called outside of the observer method invocation
 
 - 
getObserverMethodObserverMethod<T> getObserverMethod() TheObserverMethodobject that will be used by the container to invoke the observer when a matching event is fired.- Returns:
- the ObserverMethodobject that will be used by the container to call the observer method
- Throws:
- IllegalStateException- if called outside of the observer method invocation
 
 - 
addDefinitionErrorvoid addDefinitionError(Throwable t) Registers a definition error with the container, causing the container to abort deployment after bean discovery is complete.- Parameters:
- t- A- Throwablerepresenting the definition error
- Throws:
- IllegalStateException- if called outside of the observer method invocation
 
 - 
setObserverMethodvoid setObserverMethod(ObserverMethod<T> observerMethod) Replaces theObserverMethod.- Parameters:
- observerMethod- the new- ObserverMethodobject to use
- Throws:
- IllegalStateException- if called outside of the observer method invocation
- Since:
- 2.0
 
 - 
configureObserverMethodObserverMethodConfigurator<T> configureObserverMethod() Returns aObserverMethodConfiguratorinitialized with theObserverMethodprocessed 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 ObserverMethodConfiguratorto configure the replacing ObserverMethod
- Throws:
- IllegalStateException- if called outside of the observer method invocation
- Since:
- 2.0
 
 - 
vetovoid veto() Forces the container to ignore the observer method.- Throws:
- IllegalStateException- if called outside of the observer method invocation
- Since:
- 2.0
 
 
- 
 
-