View Javadoc

1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.mina.filter.codec;
21  
22  import org.apache.mina.core.session.IoSession;
23  
24  /**
25   * An abstract {@link ProtocolDecoder} implementation for those who don't need
26   * {@link ProtocolDecoder#finishDecode(IoSession, ProtocolDecoderOutput)} nor
27   * {@link ProtocolDecoder#dispose(IoSession)} method.
28   *
29   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
30   */
31  public abstract class ProtocolDecoderAdapter implements ProtocolDecoder {
32  
33      /**
34       * Override this method to deal with the closed connection.
35       * The default implementation does nothing.
36       */
37      public void finishDecode(IoSession session, ProtocolDecoderOutput out) throws Exception {
38          // Do nothing
39      }
40  
41      /**
42       * Override this method to dispose all resources related with this decoder.
43       * The default implementation does nothing.
44       */
45      public void dispose(IoSession session) throws Exception {
46          // Do nothing
47      }
48  }