EE4J Core API 10.0.0 · jakarta.enterprise.inject.build.compatible.spi.ObserverInfo

Method Summary

Modifier and Type	Method and Description
public BeanInfo	Returns: the bean declaring this observer method, or `null` if this is a synthetic observer bean() Returns the `bean` that declares this observer method.
public ClassInfo	Returns: the class that declares this observer, never `null` declaringClass() Returns the class that declares this observer.
public ParameterInfo	Returns: the event parameter of this observer method, or `null` if this is a synthetic observer eventParameter() Returns the event parameter of this observer method.
public Type	Returns: the observed event type of this observer, never `null` eventType() Returns the observed event type of this observer.
public boolean	Returns: whether this observer is asynchronous isAsync() Returns whether this observer is asynchronous.
public boolean	Returns: whether this observer is synthetic isSynthetic() Returns whether this observer is synthetic.
public MethodInfo	Returns: this observer method, or `null` if this is a synthetic observer observerMethod() Returns the declaration of this observer method.
public int	Returns: the priority of this observer priority() Returns the priority of this observer.
public Collection<AnnotationInfo>	Returns: immutable collection of observed event qualifiers, never `null` qualifiers() Returns a collection of observed event qualifiers, represented as `AnnotationInfo`.
public Reception	Returns: the reception type of this observer, never `null` reception() Returns the reception type of this observer.
public TransactionPhase	Returns: the transaction phase of this observer, or `null` if this is an asynchronous observer transactionPhase() Returns the `transaction phase` of this transactional observer.

Method Detail

bean back to summary

bean	back to summary
public BeanInfo bean() Returns the `bean` that declares this observer method. Returns `null` if this is a synthetic observer. Returns:BeanInfo the bean declaring this observer method, or `null` if this is a synthetic observer

public BeanInfo bean()

Returns the bean that declares this observer method. Returns null if this is a synthetic observer.

Returns:BeanInfo: the bean declaring this observer method, or null if this is a synthetic observer

declaringClass back to summary

declaringClass	back to summary
public ClassInfo declaringClass() Returns the class that declares this observer. In case of synthetic observers, returns the class that was designated as a declaring class during synthetic observer registration. Returns:ClassInfo the class that declares this observer, never `null`

public ClassInfo declaringClass()

Returns the class that declares this observer. In case of synthetic observers, returns the class that was designated as a declaring class during synthetic observer registration.

Returns:ClassInfo: the class that declares this observer, never null

eventParameter back to summary

eventParameter	back to summary
public ParameterInfo eventParameter() Returns the event parameter of this observer method. Returns `null` if this is a synthetic observer. Returns:ParameterInfo the event parameter of this observer method, or `null` if this is a synthetic observer

public ParameterInfo eventParameter()

Returns the event parameter of this observer method. Returns null if this is a synthetic observer.

Returns:ParameterInfo: the event parameter of this observer method, or null if this is a synthetic observer

eventType back to summary

eventType	back to summary
public Type eventType() Returns the observed event type of this observer. Returns:Type the observed event type of this observer, never `null`

public Type eventType()

Returns the observed event type of this observer.

Returns:Type: the observed event type of this observer, never null

isAsync back to summary

isAsync	back to summary
public boolean isAsync() Returns whether this observer is asynchronous. For observer methods, this means whether this observer method uses `@ObservesAsync`. Returns:boolean whether this observer is asynchronous

public boolean isAsync()

Returns whether this observer is asynchronous. For observer methods, this means whether this observer method uses @ObservesAsync.

Returns:boolean: whether this observer is asynchronous

isSynthetic	back to summary
public boolean isSynthetic() Returns whether this observer is synthetic. Returns:boolean whether this observer is synthetic

isSynthetic

back to summary

public boolean isSynthetic()

Returns whether this observer is synthetic.

Returns:boolean: whether this observer is synthetic

observerMethod back to summary

observerMethod	back to summary
public MethodInfo observerMethod() Returns the declaration of this observer method. Returns `null` if this is a synthetic observer. Returns:MethodInfo this observer method, or `null` if this is a synthetic observer

public MethodInfo observerMethod()

Returns the declaration of this observer method. Returns null if this is a synthetic observer.

Returns:MethodInfo: this observer method, or null if this is a synthetic observer

priority back to summary

priority	back to summary
public int priority() Returns the priority of this observer. This is typically defined by adding the `@Priority` annotation to the event parameter of the observer method. If the annotation is not used, the default priority, as defined by the CDI specification, is returned, Returns:int the priority of this observer

public int priority()

Returns the priority of this observer. This is typically defined by adding the @Priority annotation to the event parameter of the observer method. If the annotation is not used, the default priority, as defined by the CDI specification, is returned,

Returns:int: the priority of this observer

qualifiers back to summary

qualifiers	back to summary
public Collection<AnnotationInfo> qualifiers() Returns a collection of observed event qualifiers, represented as `AnnotationInfo`. Returns:Collection<AnnotationInfo> immutable collection of observed event qualifiers, never `null`

public Collection<AnnotationInfo> qualifiers()

Returns a collection of observed event qualifiers, represented as AnnotationInfo.

Returns:Collection<AnnotationInfo>: immutable collection of observed event qualifiers, never null

reception back to summary

reception	back to summary
public Reception reception() Returns the reception type of this observer. Allows distinguishing conditional observer methods from always notified observer methods. Returns `Reception#ALWAYS` if this is a synthetic observer. Returns:Reception the reception type of this observer, never `null`

public Reception reception()

Returns the reception type of this observer. Allows distinguishing conditional observer methods from always notified observer methods. Returns Reception#ALWAYS if this is a synthetic observer.

Returns:Reception: the reception type of this observer, never null

transactionPhase back to summary

transactionPhase	back to summary
public TransactionPhase transactionPhase() Returns the `transaction phase` of this transactional observer. Returns `TransactionPhase#IN_PROGRESS` if this is a regular synchronous observer. Returns `null` if this is an asynchronous observer. Returns:TransactionPhase the transaction phase of this observer, or `null` if this is an asynchronous observer

public TransactionPhase transactionPhase()

Returns the transaction phase of this transactional observer. Returns TransactionPhase#IN_PROGRESS if this is a regular synchronous observer. Returns null if this is an asynchronous observer.

Returns:TransactionPhase: the transaction phase of this observer, or null if this is an asynchronous observer

public Interface ObserverInfo

Method Summary

Method Detail