001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 *
019 */
020package org.apache.mina.filter.codec.demux;
021
022/**
023 * Represents results from {@link MessageDecoder}.
024 *
025 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
026 *
027 * @see MessageDecoder
028 */
029public class MessageDecoderResult {
030    /**
031     * Represents a result from {@link MessageDecoder#decodable(IoSession, IoBuffer)}
032     * and {@link MessageDecoder#decode(IoSession, IoBuffer, ProtocolDecoderOutput)}.
033     * Please refer to each method's documentation for detailed explanation.
034     */
035    public static final MessageDecoderResult OK = new MessageDecoderResult("OK");
036
037    /**
038     * Represents a result from {@link MessageDecoder#decodable(IoSession, IoBuffer)}
039     * and {@link MessageDecoder#decode(IoSession, IoBuffer, ProtocolDecoderOutput)}.
040     * Please refer to each method's documentation for detailed explanation.
041     */
042    public static final MessageDecoderResult NEED_DATA = new MessageDecoderResult("NEED_DATA");
043
044    /**
045     * Represents a result from {@link MessageDecoder#decodable(IoSession, IoBuffer)}
046     * and {@link MessageDecoder#decode(IoSession, IoBuffer, ProtocolDecoderOutput)}.
047     * Please refer to each method's documentation for detailed explanation.
048     */
049    public static final MessageDecoderResult NOT_OK = new MessageDecoderResult("NOT_OK");
050
051    private final String name;
052
053    private MessageDecoderResult(String name) {
054        this.name = name;
055    }
056
057    @Override
058    public String toString() {
059        return name;
060    }
061}