org.jboss.weld.experimental

Interface ExperimentalEvent<T>

Type Parameters:

T - the event type

All Superinterfaces:

Event<T>

All Known Implementing Classes:

EventImpl

public interface ExperimentalEvent<T>
extends Event<T>

This API is experimental and will change! All the methods declared by this interface are supposed to be moved to Event.

Author:

Jozef Hartinger

Method Summary

Modifier and Type	Method and Description
<U extends T> CompletionStage<U>	fireAsync(U event) Fires an event with the specified qualifiers and notifies observers asynchronously.
<U extends T> CompletionStage<U>	fireAsync(U event, Executor executor) Same as fireAsync(Object) but allows an executor, which is used for asynchronous event delivery, to be specified.
ExperimentalEvent<T>	select(Annotation... qualifiers) Obtains a child Event for the given additional required qualifiers.
<U extends T> ExperimentalEvent<U>	select(Class<U> subtype, Annotation... qualifiers) Obtains a child Event for the given required type and additional required qualifiers.
<U extends T> ExperimentalEvent<U>	select(TypeLiteral<U> subtype, Annotation... qualifiers) Obtains a child Event for the given required type and additional required qualifiers.

Methods inherited from interface javax.enterprise.event.Event

fire

Method Detail

fireAsync

<U extends T> CompletionStage<U> fireAsync(U event)

Fires an event with the specified qualifiers and notifies observers asynchronously.

Observers bound to a transaction phase are registered to be executed in the corresponding transaction phase. Observers with TransactionPhase.IN_PROGRESS are notified in a configured thread pool. The ordering of observers is preserved. The message may be mutable and is guaranteed to be safely propagated between observers.

If there are multiple observers for the given event, a given observer is guaranteed to observe the event in a consistent state in which is:

• the state in which the event was left in by an observer executing before the given observer, or
• the initial state of the event if the given observer is the first one

The returned CompletionStage allows actions, which execute upon termination of this asynchronous dispatch, to be registered.

Type Parameters:

U - the event type

Parameters:

event - the event object

Returns:

completion stage which allows additional actions to be bound to the asynchronous event dispatch

Throws:

IllegalArgumentException - if the runtime type of the event object contains a type variable

See Also:

CompletionStage

fireAsync

<U extends T> CompletionStage<U> fireAsync(U event,
                                           Executor executor)

Same as fireAsync(Object) but allows an executor, which is used for asynchronous event delivery, to be specified.

Type Parameters:

U - the event type

Parameters:

event - the event object

executor - the executor to be used for asynchronous event delivery

Returns:

completion stage which allows additional actions to be bound to the asynchronous event dispatch

Throws:

IllegalArgumentException - if the runtime type of the event object contains a type variable

select

ExperimentalEvent<T> select(Annotation... qualifiers)

Description copied from interface: Event

Obtains a child Event for the given additional required qualifiers.

Specified by:

select in interface Event<T>

Parameters:

qualifiers - the additional specified qualifiers

Returns:

the child Event

select

<U extends T> ExperimentalEvent<U> select(Class<U> subtype,
                                          Annotation... qualifiers)

Description copied from interface: Event

Obtains a child Event for the given required type and additional required qualifiers.

Specified by:

select in interface Event<T>

Type Parameters:

U - the specified type

Parameters:

subtype - a Class representing the specified type

qualifiers - the additional specified qualifiers

Returns:

the child Event

select

<U extends T> ExperimentalEvent<U> select(TypeLiteral<U> subtype,
                                          Annotation... qualifiers)

Description copied from interface: Event

Obtains a child Event for the given required type and additional required qualifiers.

Specified by:

select in interface Event<T>

Type Parameters:

U - the specified type

Parameters:

subtype - a TypeLiteral representing the specified type

qualifiers - the additional specified qualifiers

Returns:

the child Event