ObserverMethodImpl (Weld Servlet (Uber Jar) 3.0.0.Alpha12 API)

java.lang.Object
- org.jboss.weld.event.ObserverMethodImpl<T,X>

All Implemented Interfaces:

ObserverMethod<T>, Prioritized

Direct Known Subclasses:

ExtensionObserverMethodImpl
```
public class ObserverMethodImpl<T,X>
extends Object
implements ObserverMethod<T>
```
Reference implementation for the ObserverMethod interface, which represents an observer method. Each observer method has an event type which is the class of the event object being observed, and event binding types that are annotations applied to the event parameter to narrow the event notifications delivered.

Author:

David Allen, Jozef Hartinger, Marko Luksa

Field Summary

Fields
Modifier and Type	Field and Description
`protected BeanManagerImpl`	`beanManager`
`protected RIBean<X>`	`declaringBean`
`static String`	`ID_PREFIX`
`static String`	`ID_SEPARATOR`
`protected MethodInjectionPoint<T,? super X>`	`observerMethod`
`protected static Set<Class<? extends Annotation>>`	`SPECIAL_PARAM_MARKERS`
`protected TransactionPhase`	`transactionPhase`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ObserverMethodImpl(EnhancedAnnotatedMethod<T,? super X> observer, RIBean<X> declaringBean, BeanManagerImpl manager, boolean isAsync)` Creates an Observer which describes and encapsulates an observer method (8.5).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected static String`	`createId(EnhancedAnnotatedMethod<?,?> observer, RIBean<?> declaringBean)`
`boolean`	`equals(Object obj)`
`Class<X>`	`getBeanClass()` Obtains the class of the type that declares the observer method.
`RIBean<X>`	`getDeclaringBean()`
`protected EnhancedAnnotatedParameter<?,? super X>`	`getEventParameter(EnhancedAnnotatedMethod<T,? super X> observer)`
`String`	`getId()`
`Set<WeldInjectionPointAttributes<?,?>>`	`getInjectionPoints()`
`MethodInjectionPoint<T,? super X>`	`getMethod()`
`Set<WeldInjectionPointAttributes<?,?>>`	`getNewInjectionPoints()`
`Set<Annotation>`	`getObservedQualifiers()` Obtains the set of observed event qualifiers.
`Type`	`getObservedType()` Obtains the observed event type.
`int`	`getPriority()` The priority that will be used by the container to determine the notification order in which event observer methods are invoked.
`protected Object`	`getReceiver(CreationalContext<X> creationalContext)`
`Reception`	`getReception()` Obtains the specified `Reception` for the observer method.
`TransactionPhase`	`getTransactionPhase()` Obtains the specified `TransactionPhase` for the observer method.
`int`	`hashCode()`
`protected void`	`checkRequiredTypeAnnotations(EnhancedAnnotatedParameter<?,?> eventParameter)`
`void`	`initialize(EnhancedAnnotatedMethod<T,? super X> annotated)` Completes initialization of the observer and allows derived types to override behavior.
`protected MethodInjectionPoint<T,? super X>`	`initMethodInjectionPoint(EnhancedAnnotatedMethod<T,? super X> observer, RIBean<X> declaringBean, BeanManagerImpl manager)`
`boolean`	`isAsync()` Determines if this observer method is asynchronous
`boolean`	`isEventMetadataRequired()`
`void`	`notify(T event)` Calls the observer method, passing the given event object.
`protected void`	`postNotify(T event, Object receiver)`
`protected void`	`preNotify(T event, Object receiver)` Hooks allowing subclasses to perform additional logic just before and just after an event is delivered to an observer method.
`protected void`	`sendEvent(T event)` Invokes the observer method immediately passing the event.
`protected void`	`sendEvent(T event, Object receiver, CreationalContext<?> creationalContext)` Note that `CreationalContext.release()` is not invoked within this method.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ID_PREFIX
```
public static final String ID_PREFIX
```
  - ID_SEPARATOR
```
public static final String ID_SEPARATOR
```
    See Also:
    
    Constant Field Values
  - SPECIAL_PARAM_MARKERS
```
protected static final Set<Class<? extends Annotation>> SPECIAL_PARAM_MARKERS
```
  - beanManager
```
protected final BeanManagerImpl beanManager
```
  - declaringBean
```
protected final RIBean<X> declaringBean
```
  - observerMethod
```
protected final MethodInjectionPoint<T,? super X> observerMethod
```
  - transactionPhase
```
protected TransactionPhase transactionPhase
```
- Constructor Detail
  - ObserverMethodImpl
```
protected ObserverMethodImpl(EnhancedAnnotatedMethod<T,? super X> observer,
                             RIBean<X> declaringBean,
                             BeanManagerImpl manager,
                             boolean isAsync)
```
    Creates an Observer which describes and encapsulates an observer method (8.5).
    
    Parameters:
    
    observer - The observer
    
    declaringBean - The observer bean
    
    manager - The Bean manager
- Method Detail
  - getEventParameter
```
protected EnhancedAnnotatedParameter<?,? super X> getEventParameter(EnhancedAnnotatedMethod<T,? super X> observer)
```
  - createId
```
protected static String createId(EnhancedAnnotatedMethod<?,?> observer,
                                 RIBean<?> declaringBean)
```
  - initMethodInjectionPoint
```
protected MethodInjectionPoint<T,? super X> initMethodInjectionPoint(EnhancedAnnotatedMethod<T,? super X> observer,
                                                                     RIBean<X> declaringBean,
                                                                     BeanManagerImpl manager)
```
  - getInjectionPoints
```
public Set<WeldInjectionPointAttributes<?,?>> getInjectionPoints()
```
  - getNewInjectionPoints
```
public Set<WeldInjectionPointAttributes<?,?>> getNewInjectionPoints()
```
  - checkRequiredTypeAnnotations
```
protected void checkRequiredTypeAnnotations(EnhancedAnnotatedParameter<?,?> eventParameter)
```
  - getBeanClass
```
public Class<X> getBeanClass()
```
    Description copied from interface: ObserverMethod
    
    Obtains the class of the type that declares the observer method.
    
    Specified by:
    
    getBeanClass in interface ObserverMethod<T>
    
    Returns:
    
    the defining class
  - getDeclaringBean
```
public RIBean<X> getDeclaringBean()
```
  - getReception
```
public Reception getReception()
```
    Description copied from interface: ObserverMethod
    
    Obtains the specified Reception for the observer method. This indicates if the observer is conditional or not.
    
    Specified by:
    
    getReception in interface ObserverMethod<T>
    
    Returns:
    
    the Reception
  - getObservedQualifiers
```
public Set<Annotation> getObservedQualifiers()
```
    Description copied from interface: ObserverMethod
    
    Obtains the set of observed event qualifiers.
    
    Specified by:
    
    getObservedQualifiers in interface ObserverMethod<T>
    
    Returns:
    
    the observed event qualifiers
  - getObservedType
```
public Type getObservedType()
```
    Description copied from interface: ObserverMethod
    
    Obtains the observed event type.
    
    Specified by:
    
    getObservedType in interface ObserverMethod<T>
    
    Returns:
    
    the observed event type
  - getTransactionPhase
```
public TransactionPhase getTransactionPhase()
```
    Description copied from interface: ObserverMethod
    
    Obtains the specified TransactionPhase for the observer method.
    
    Specified by:
    
    getTransactionPhase in interface ObserverMethod<T>
    
    Returns:
    
    the TransactionPhase
  - getMethod
```
public MethodInjectionPoint<T,? super X> getMethod()
```
    Returns:
    
    the observerMethod
  - initialize
```
public void initialize(EnhancedAnnotatedMethod<T,? super X> annotated)
```
    Completes initialization of the observer and allows derived types to override behavior.
  - notify
```
public void notify(T event)
```
    Description copied from interface: ObserverMethod
    
    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 ObserverMethod.getReception() returns Reception.IF_EXISTS.
    
    Specified by:
    
    notify in interface ObserverMethod<T>
    
    Parameters:
    
    event - the event object
  - sendEvent
```
protected void sendEvent(T event)
```
    Invokes the observer method immediately passing the event.
    
    Parameters:
    
    event - The event to notify observer with
  - sendEvent
```
protected void sendEvent(T event,
                         Object receiver,
                         CreationalContext<?> creationalContext)
```
    Note that CreationalContext.release() is not invoked within this method.
    
    Parameters:
    
    event -
    
    receiver -
    
    creationalContext -
  - preNotify
```
protected void preNotify(T event,
                         Object receiver)
```
    Hooks allowing subclasses to perform additional logic just before and just after an event is delivered to an observer method.
  - postNotify
```
protected void postNotify(T event,
                          Object receiver)
```
  - getReceiver
```
protected Object getReceiver(CreationalContext<X> creationalContext)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getId
```
public String getId()
```
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getPriority
```
public int getPriority()
```
    Description copied from interface: ObserverMethod
    
    The priority that will be used by the container to determine the notification order in which event observer methods are invoked.
    
    Specified by:
    
    getPriority in interface ObserverMethod<T>
    
    Specified by:
    
    getPriority in interface Prioritized
    
    Returns:
    
    The priority that will be used by the container to determine the notification order in which event observer methods are invoked.
  - isAsync
```
public boolean isAsync()
```
    Description copied from interface: ObserverMethod
    
    Determines if this observer method is asynchronous
    
    Specified by:
    
    isAsync in interface ObserverMethod<T>
    
    Returns:
    
    returns true if the method is an asynchronous observer method (i.e. defined with ObservesAsync), otherwise returns false
  - isEventMetadataRequired
```
public boolean isEventMetadataRequired()
```

Class ObserverMethodImpl<T,X>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ID_PREFIX

ID_SEPARATOR

SPECIAL_PARAM_MARKERS

beanManager

declaringBean

observerMethod

transactionPhase

Constructor Detail

ObserverMethodImpl

Method Detail

getEventParameter

createId

initMethodInjectionPoint

getInjectionPoints

getNewInjectionPoints

checkRequiredTypeAnnotations

getBeanClass

getDeclaringBean

getReception

getObservedQualifiers

getObservedType

getTransactionPhase

getMethod

initialize

notify

sendEvent

sendEvent

preNotify

postNotify

getReceiver

toString

getId

equals

hashCode

getPriority

isAsync

isEventMetadataRequired