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