net.sf.eBus.client.NotifyCallback Maven / Gradle / Ivy

Go to download

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

There is a newer version: 7.6.0

//
// Copyright 2016 Charles W. Rapp
//
// 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 net.sf.eBus.client;

import net.sf.eBus.messages.ENotificationMessage;

/**
 * This functional interface may be used to handle notification
 * message delivery instead of
 * {@link ESubscriber#notify(ENotificationMessage, IESubscribeFeed)}
 * by passing a {@code NotifyCallback} instance to
 * {@link ESubscribeFeed.Builder#notifyCallback(NotifyCallback)}.
 * This allows a tighter coupling between a feed and the code for
 * processing the feed's notification messages.
 *
 * @param  notification message type passed back to
 * subscriber.
 *
 * @see ESubscribeFeed.Builder#notifyCallback(NotifyCallback)
 *
 * @author Charles W. Rapp
 */

@FunctionalInterface
public interface NotifyCallback
{
//---------------------------------------------------------------
// Member methods.
//

    /**
     * An incoming notification message from {@code feed}.
     * @param msg eBus notification message.
     * @param feed the associated subscription feed.
     */
    void call(T msg,
              IESubscribeFeed feed);
} // end of interface NotifyCallback