Jakarta EE 11.0.0 · jakarta.enterprise.inject.spi.ObserverMethod

Modifier and Type	Field and Description
public static final int	DEFAULT_PRIORITY The default observer priority

Method Summary

Modifier and Type	Method and Description
public Class<?>	Returns: the defining class getBeanClass() Obtains the class of the type that declares the observer method.
public default Bean<?>	Returns: the declaring bean getDeclaringBean() Obtains the bean that declares the observer method.
public Set<Annotation>	Returns: the observed event qualifiers getObservedQualifiers() Obtains the set of observed event qualifiers.
public Type	Returns: the observed event type getObservedType() Obtains the observed event type.
public default int	Returns: The priority that will be used by the container to determine the notification order in which event observer methods are invoked. getPriority() Implements jakarta.enterprise.inject.spi.Prioritized.getPriority. The priority that will be used by the container to determine the notification order in which event observer methods are invoked.
public Reception	Returns: the `Reception` getReception() Obtains the specified `Reception` for the observer method.
public TransactionPhase	Returns: the `TransactionPhase` getTransactionPhase() Obtains the specified `TransactionPhase` for the observer method.
public default boolean	Returns: returns `true` if the method is an asynchronous observer method (i.e. defined with `ObservesAsync`), otherwise returns `false` isAsync() Determines if this observer method is asynchronous
public default void	notify(T the event object event) Calls the observer method, passing the given event object.
public default void	notify(EventContext<T> `EventContext` used to notify observers eventContext) Calls the observer method, passing the given event context.

DEFAULT_PRIORITY	back to summary
public static final int DEFAULT_PRIORITY The default observer priority

Method Detail

getBeanClass	back to summary
public Class<?> getBeanClass() Obtains the class of the type that declares the observer method. Returns:Class<?> the defining class

getBeanClass

back to summary

public Class<?> getBeanClass()

Obtains the class of the type that declares the observer method.

Returns:Class<?>: the defining class

getDeclaringBean back to summary

getDeclaringBean	back to summary
public default Bean<?> getDeclaringBean() Obtains the bean that declares the observer method. For synthetic observers, the return value is undefined. For the sake of compatibility with existing custom `ObserverMethod` implementations, this method by default returns `null`. Returns:Bean<?> the declaring bean Since 4.0

public default Bean<?> getDeclaringBean()

Obtains the bean that declares the observer method. For synthetic observers, the return value is undefined.

For the sake of compatibility with existing custom ObserverMethod implementations, this method by default returns null.

Returns:Bean<?>: the declaring bean
Since: 4.0

getObservedQualifiers	back to summary
public Set<Annotation> getObservedQualifiers() Obtains the set of observed event qualifiers. Returns:Set<Annotation> the observed event qualifiers

getObservedQualifiers

back to summary

public Set<Annotation> getObservedQualifiers()

Obtains the set of observed event qualifiers.

Returns:Set<Annotation>: the observed event qualifiers

getObservedType	back to summary
public Type getObservedType() Obtains the observed event type. Returns:Type the observed event type

getObservedType

back to summary

public Type getObservedType()

Obtains the observed event type.

Returns:Type: the observed event type

getPriority	back to summary
public default int getPriority() Implements jakarta.enterprise.inject.spi.Prioritized.getPriority. The priority that will be used by the container to determine the notification order in which event observer methods are invoked. Returns:int The priority that will be used by the container to determine the notification order in which event observer methods are invoked. Annotations @Override Since 2.0

getPriority

back to summary

public default int getPriority()

Implements jakarta.enterprise.inject.spi.Prioritized.getPriority.

The priority that will be used by the container to determine the notification order in which event observer methods are invoked.

Returns:int

The priority that will be used by the container to determine the notification order in which event observer methods are invoked.

Annotations

@Override

Since

2.0

getReception back to summary

getReception	back to summary
public Reception getReception() Obtains the specified `Reception` for the observer method. This indicates if the observer is conditional or not. Returns:Reception the `Reception`

public Reception getReception()

Obtains the specified Reception for the observer method. This indicates if the observer is conditional or not.

Returns:Reception: the Reception

getTransactionPhase back to summary

getTransactionPhase	back to summary
public TransactionPhase getTransactionPhase() Obtains the specified `TransactionPhase` for the observer method. Returns:TransactionPhase the `TransactionPhase`

public TransactionPhase getTransactionPhase()

Obtains the specified TransactionPhase for the observer method.

Returns:TransactionPhase: the TransactionPhase

isAsync back to summary

isAsync	back to summary
public default boolean isAsync() Determines if this observer method is asynchronous Returns:boolean returns `true` if the method is an asynchronous observer method (i.e. defined with `ObservesAsync`), otherwise returns `false`

public default boolean isAsync()

Determines if this observer method is asynchronous

Returns:boolean: returns true if the method is an asynchronous observer method (i.e. defined with ObservesAsync), otherwise returns false

notify back to summary

notify	back to summary
public default void notify(T event) Calls the observer method, passing the given event object. The implementation of this method for a custom observer method is responsible for deciding whether to call the method if the `getReception()` returns `Reception#IF_EXISTS`. Parameters event:T the event object

public default void notify(T event)

Calls the observer method, passing the given event object.

The implementation of this method for a custom observer method is responsible for deciding whether to call the method if the getReception() returns Reception#IF_EXISTS.

Parameters

event:T: the event object

notify back to summary

notify	back to summary
public default void notify(EventContext<T> eventContext) Calls the observer method, passing the given event context. The container should always call this method, but the default implementation delegates to `notify(Object)`. The implementation of this method for a custom observer method is responsible for deciding whether to call the method if the `getReception()` returns `Reception#IF_EXISTS`. Parameters eventContext:EventContext<T> `EventContext` used to notify observers

public default void notify(EventContext<T> eventContext)

Calls the observer method, passing the given event context.

The container should always call this method, but the default implementation delegates to notify(Object).

The implementation of this method for a custom observer method is responsible for deciding whether to call the method if the getReception() returns Reception#IF_EXISTS.

Parameters

eventContext:EventContext<T>: EventContext used to notify observers

public Interface ObserverMethod<T>

Field Summary

Method Summary

Field Detail

Method Detail