org.apache.mina.filter.codec.ProtocolDecoderAdapter Maven / Gradle / Ivy

/**
 * Copyright 2007-2015, Kaazing Corporation. All rights reserved.
 *
 * 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 org.apache.mina.filter.codec;

import org.apache.mina.core.session.IoSession;

/**
 * An abstract {@link ProtocolDecoder} implementation for those who don't need
 * {@link ProtocolDecoder#finishDecode(IoSession, ProtocolDecoderOutput)} nor
 * {@link ProtocolDecoder#dispose(IoSession)} method.
 *
 * @author Apache MINA Project
 */
public abstract class ProtocolDecoderAdapter implements ProtocolDecoder {

    /**
     * Override this method to deal with the closed connection.
     * The default implementation does nothing.
     */
    public void finishDecode(IoSession session, ProtocolDecoderOutput out)
            throws Exception {
        // Do nothing
    }

    /**
     * Override this method to dispose all resources related with this decoder.
     * The default implementation does nothing.
     */
    public void dispose(IoSession session) throws Exception {
        // Do nothing
    }
}