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.core.buffer.IoBuffer;
23  import org.apache.mina.core.session.IoSession;
24  import org.apache.mina.filter.codec.ProtocolDecoderOutput;
25  
26  /**
27   * Represents results from {@link MessageDecoder}.
28   *
29   * @author <a href="http://mina.apache.org">Apache MINA Project</a>
30   *
31   * @see MessageDecoder
32   */
33  public class MessageDecoderResult {
34      /**
35       * Represents a result from {@link MessageDecoder#decodable(IoSession, IoBuffer)}
36       * and {@link MessageDecoder#decode(IoSession, IoBuffer, ProtocolDecoderOutput)}.
37       * Please refer to each method's documentation for detailed explanation.
38       */
39      public static final MessageDecoderResult OK = new MessageDecoderResult("OK");
40  
41      /**
42       * Represents a result from {@link MessageDecoder#decodable(IoSession, IoBuffer)}
43       * and {@link MessageDecoder#decode(IoSession, IoBuffer, ProtocolDecoderOutput)}.
44       * Please refer to each method's documentation for detailed explanation.
45       */
46      public static final MessageDecoderResult NEED_DATA = new MessageDecoderResult("NEED_DATA");
47  
48      /**
49       * Represents a result from {@link MessageDecoder#decodable(IoSession, IoBuffer)}
50       * and {@link MessageDecoder#decode(IoSession, IoBuffer, ProtocolDecoderOutput)}.
51       * Please refer to each method's documentation for detailed explanation.
52       */
53      public static final MessageDecoderResult NOT_OK = new MessageDecoderResult("NOT_OK");
54  
55      private final String name;
56  
57      private MessageDecoderResult(String name) {
58          this.name = name;
59      }
60  
61      @Override
62      public String toString() {
63          return name;
64      }
65  }