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.demux;
21  
22  import org.apache.mina.common.ByteBuffer;
23  import org.apache.mina.common.IoSession;
24  import org.apache.mina.filter.codec.ProtocolDecoderOutput;
25  
26  /**
27   * Represents results from {@link MessageDecoder}.
28   * 
29   * @author The Apache Directory Project (mina-dev@directory.apache.org)
30   * @version $Rev: 555855 $, $Date: 2007-07-13 12:19:00 +0900 (Fri, 13 Jul 2007) $
31   * 
32   * @see MessageDecoder
33   */
34  public class MessageDecoderResult {
35      /**
36       * Represents a result from {@link MessageDecoder#decodable(IoSession, ByteBuffer)}
37       * and {@link MessageDecoder#decode(IoSession, ByteBuffer, ProtocolDecoderOutput)}.
38       * Please refer to each method's documentation for detailed explanation.
39       */
40      public static MessageDecoderResult OK = new MessageDecoderResult("OK");
41  
42      /**
43       * Represents a result from {@link MessageDecoder#decodable(IoSession, ByteBuffer)}
44       * and {@link MessageDecoder#decode(IoSession, ByteBuffer, ProtocolDecoderOutput)}.
45       * Please refer to each method's documentation for detailed explanation.
46       */
47      public static MessageDecoderResult NEED_DATA = new MessageDecoderResult(
48              "NEED_DATA");
49  
50      /**
51       * Represents a result from {@link MessageDecoder#decodable(IoSession, ByteBuffer)}
52       * and {@link MessageDecoder#decode(IoSession, ByteBuffer, ProtocolDecoderOutput)}.
53       * Please refer to each method's documentation for detailed explanation.
54       */
55      public static MessageDecoderResult NOT_OK = new MessageDecoderResult(
56              "NOT_OK");
57  
58      private final String name;
59  
60      private MessageDecoderResult(String name) {
61          this.name = name;
62      }
63  
64      public String toString() {
65          return name;
66      }
67  }