com.elusive_code.newsboy.NotificationFuture Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of NewsBoy Show documentation

Asynchronous publish-subscribe communication library. Features: 1. Listeners are stored using WeakReferences to prevent memory leaks when they are not unsubscribed. 2. Uses fork-join framework for concurrent event delivery. 3. Publish methods returns collection of Futures that represent event notifications. 4. Supports ordered publishing: guaranteed to notify of the events in order they were published. 5. Provides EventSource and EventService interfaces for better integration with IOC containers and alternative implementations.

The newest version!

/*
 * Copyright 2014. Vladislav Dolgikh
 *
 * 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 com.elusive_code.newsboy;

import java.lang.reflect.Method;
import java.util.concurrent.Future;

/**
 * Future that represent notification results
 * Adds notification information to the {@link java.util.concurrent.Future}:
 * 
 *     event that triggered notification
 *     listener being notified
 *     method of the listener used to handle event
 * 
 *
 * @see java.util.concurrent.Future
 * @see com.elusive_code.newsboy.EventService
 * @author Vladislav Dolgikh
 */
public interface NotificationFuture extends Future {

    /**
     * Returns listener being notified
     * @return target listener
     */
    Object getListener();

    /**
     * Returns method of the listener handling notification
     * @return listener method
     */
    Method getMethod();

    /**
     * Returns triggered event
     * @return triggered event
     */
    Object getEvent();

}