View Javadoc

1   /*
2    *   @(#) $Id: MessageDecoderResult.java 332218 2005-11-10 03:52:42Z trustin $
3    *
4    *   Copyright 2004 The Apache Software Foundation
5    *
6    *   Licensed under the Apache License, Version 2.0 (the "License");
7    *   you may not use this file except in compliance with the License.
8    *   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, software
13   *   distributed under the License is distributed on an "AS IS" BASIS,
14   *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15   *   See the License for the specific language governing permissions and
16   *   limitations under the License.
17   *
18   */
19  package org.apache.mina.protocol.codec;
20  
21  import org.apache.mina.common.ByteBuffer;
22  import org.apache.mina.protocol.ProtocolDecoderOutput;
23  import org.apache.mina.protocol.ProtocolSession;
24  
25  /***
26   * Represents results from {@link MessageDecoder}.
27   * 
28   * @author The Apache Directory Project (dev@directory.apache.org)
29   * @version $Rev: 332218 $, $Date: 2005-11-10 12:52:42 +0900 $
30   * 
31   * @see MessageDecoder
32   */
33  public class MessageDecoderResult
34  {
35      /***
36       * Represents a result from {@link MessageDecoder#decodable(ProtocolSession, ByteBuffer)}
37       * and {@link MessageDecoder#decode(ProtocolSession, 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(ProtocolSession, ByteBuffer)}
44       * and {@link MessageDecoder#decode(ProtocolSession, ByteBuffer, ProtocolDecoderOutput)}.
45       * Please refer to each method's documentation for detailed explanation.
46       */
47      public static MessageDecoderResult NEED_DATA = new MessageDecoderResult( "NEED_DATA" );
48  
49      /***
50       * Represents a result from {@link MessageDecoder#decodable(ProtocolSession, ByteBuffer)}
51       * and {@link MessageDecoder#decode(ProtocolSession, ByteBuffer, ProtocolDecoderOutput)}.
52       * Please refer to each method's documentation for detailed explanation.
53       */
54      public static MessageDecoderResult NOT_OK = new MessageDecoderResult( "NOT_OK" );
55  
56      private final String name;
57  
58      private MessageDecoderResult( String name )
59      {
60          this.name = name;
61      }
62      
63      public String toString()
64      {
65          return name;
66      }
67  }