jakarta.enterprise.event.NotificationOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jakarta.enterprise.cdi-api Show documentation
APIs for CDI (Contexts and Dependency Injection for Java)
The newest version!
/*
 * Copyright 2016, Red Hat, Inc., and individual contributors
 *
 * Licensed 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 jakarta.enterprise.event;

import java.util.concurrent.Executor;

/**
 * Notification options are used to configure observer notification.
 *
 * @author Martin Kouba
 * @see Event#fireAsync(Object, NotificationOptions)
 * @since 2.0
 */
public interface NotificationOptions {

    /**
     *
     * @return the executor used to execute an asynchronous event
     */
    Executor getExecutor();

    /**
     *
     * @param optionName name of the option to get value of
     * @return the value of an option or null if no option for the given name exists
     */
    Object get(String optionName);

    /**
     *
     * @param executor a specific {@link Executor} to handle observer notification
     * @return an immutable holder of an executor
     */
    static NotificationOptions ofExecutor(Executor executor) {
        return builder().setExecutor(executor).build();
    }

    /**
     *
     * @param optionName name of the option to set
     * @param optionValue value for the option
     * @return an immutable holder of a single option
     */
    static NotificationOptions of(String optionName, Object optionValue) {
        return builder().set(optionName, optionValue).build();
    }

    /**
     *
     * @return the options builder
     */
    static Builder builder() {
        return new ImmutableNotificationOptions.Builder();
    }

    /**
     * Notification options builder.
     *
     * @author Martin Kouba
     * @since 2.0
     */
    interface Builder {

        /**
         * Set the notification executor
         *
         * @param executor the {@linkplain Executor}
         * @return this
         */
        Builder setExecutor(Executor executor);

        /**
         * Set an option value
         *
         * @param optionName option name
         * @param optionValue option value
         * @return this
         */
        Builder set(String optionName, Object optionValue);

        /**
         * Build the notification options
         *
         * @return NotificationOptions
         */
        NotificationOptions build();

    }

}