/*
 * Copyright (c) 2009, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package com.sun.nio.sctp;

A skeletal handler that consumes notifications and continues.
 This class trivially implements the handleNotification methods to return CONTINUE so that all notifications are consumed and the channel continues to try and receive a message. 
 It also provides overloaded versions of the handleNotification methods, one for each of the required supported notification types, AssociationChangeNotification, PeerAddressChangeNotification, SendFailedNotification, and ShutdownNotification. The appropriate method will be invoked when the notification is received. 
Since:
1.7/**
 * A skeletal handler that consumes notifications and continues.
 *
 * <P> This class trivially implements the {@code handleNotification} methods to
 * return {@link HandlerResult#CONTINUE CONTINUE} so that all notifications are
 * consumed and the channel continues to try and receive a message.
 *
 * <P> It also provides overloaded versions of the {@code handleNotification}
 * methods, one for each of the required supported notification types, {@link
 * AssociationChangeNotification}, {@link PeerAddressChangeNotification},
 * {@link SendFailedNotification}, and {@link ShutdownNotification}. The
 * appropriate method will be invoked when the notification is received.
 *
 * @since 1.7
 */
public class AbstractNotificationHandler<T>
    implements NotificationHandler<T>
{
    
Initializes a new instance of this class.
/**
     * Initializes a new instance of this class.
     */
    protected AbstractNotificationHandler() {}

    
Invoked when an implementation specific notification is received from the
SCTP stack.
Params:
notification – 
        The notification
attachment –  The object attached to the receive operation when it was initiated.
Returns:
 The handler result/**
     * Invoked when an implementation specific notification is received from the
     * SCTP stack.
     *
     * @param  notification
     *         The notification
     *
     * @param  attachment
     *         The object attached to the {@code receive} operation when it was
     *         initiated.
     *
     * @return  The handler result
     */
    @Override
    public HandlerResult handleNotification(Notification notification,
                                            T attachment) {
        return HandlerResult.CONTINUE;
    }

    
Invoked when an AssociationChangeNotification is received from the SCTP stack. 
Params:
notification – 
        The notification
attachment –  The object attached to the receive operation when it was initiated.
Returns:
 The handler result/**
     * Invoked when an {@link AssociationChangeNotification} is received from
     * the SCTP stack.
     *
     * @param  notification
     *         The notification
     *
     * @param  attachment
     *         The object attached to the {@code receive} operation when it was
     *         initiated.
     *
     * @return  The handler result
     */
    public HandlerResult handleNotification(AssociationChangeNotification notification,
                                            T attachment) {
        return HandlerResult.CONTINUE;
    }

    
Invoked when an PeerAddressChangeNotification is received from the SCTP stack. 
Params:
notification – 
        The notification
attachment –  The object attached to the receive operation when it was initiated.
Returns:
 The handler result/**
     * Invoked when an {@link PeerAddressChangeNotification} is received from
     * the SCTP stack.
     *
     * @param  notification
     *         The notification
     *
     * @param  attachment
     *         The object attached to the {@code receive} operation when it was
     *         initiated.
     *
     * @return  The handler result
     */
    public HandlerResult handleNotification(PeerAddressChangeNotification notification,
                                            T attachment) {
        return HandlerResult.CONTINUE;
    }

    
Invoked when an SendFailedNotification is received from the SCTP stack. 
Params:
notification – 
        The notification
attachment –  The object attached to the receive operation when it was initiated.
Returns:
 The handler result/**
     * Invoked when an {@link SendFailedNotification} is received from
     * the SCTP stack.
     *
     * @param  notification
     *         The notification
     *
     * @param  attachment
     *         The object attached to the {@code receive} operation when it was
     *         initiated.
     *
     * @return  The handler result
     */
    public HandlerResult handleNotification(SendFailedNotification notification,
                                            T attachment) {
        return HandlerResult.CONTINUE;
    }

    
Invoked when an ShutdownNotification is received from the SCTP stack. 
Params:
notification – 
        The notification
attachment –  The object attached to the receive operation when it was initiated.
Returns:
 The handler result/**
     * Invoked when an {@link ShutdownNotification} is received from
     * the SCTP stack.
     *
     * @param  notification
     *         The notification
     *
     * @param  attachment
     *         The object attached to the {@code receive} operation when it was
     *         initiated.
     *
     * @return  The handler result
     */
    public HandlerResult handleNotification(ShutdownNotification notification,
                                            T attachment) {
        return HandlerResult.CONTINUE;
    }
}