All Downloads are FREE. Search and download functionalities are using the official Maven repository.

javax.enterprise.event.Event Maven / Gradle / Ivy

There is a newer version: 8.0-6
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package javax.enterprise.event;

import java.lang.annotation.Annotation;
import java.util.concurrent.CompletionStage;
import javax.enterprise.util.TypeLiteral;

/**
 * The event interface is used for firing events with specific classifiers and types.
 *
 * A built-in event bean is provided by the container.
 * 
 * @param  the event type 
 */
public interface Event
{

    void fire(T event);

    /**
     * Fires the given event asynchronous and notifies all {@link ObservesAsync} observers.
     *
     * @param asyncEvent event to fire async
     * @param  the type of the result
     *
     * @return {@link CompletionStage} with type {@code U}
     *
     * @since 2.0
     */
     CompletionStage fireAsync(U asyncEvent);

    /**
     * Fires the given event asynchronous and notifies all {@link ObservesAsync} observers.
     *
     * @param asyncEvent event to fire async
     * @param notificationOptions
     * @param  type of the result
     *
     * @return {@link CompletionStage} with type {@code U}
     *
     * @since 2.0
     */
    //X TODO add notificationOptions to javadoc
     CompletionStage  fireAsync(U asyncEvent, NotificationOptions notificationOptions);

    Event select(Annotation... qualifiers);
    
     Event select(Class subtype, Annotation... qualifiers);
    
     Event select(TypeLiteral subtype,
                                  Annotation... qualifiers);

}