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.statemachine;
21
22 import org.apache.mina.core.buffer.IoBuffer;
23 import org.apache.mina.filter.codec.ProtocolDecoderException;
24 import org.apache.mina.filter.codec.ProtocolDecoderOutput;
25
26 /**
27 * {@link DecodingState} which decodes <code>byte</code> values.
28 *
29 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
30 */
31 public abstract class SingleByteDecodingState implements DecodingState {
32 /**
33 * {@inheritDoc}
34 */
35 @Override
36 public DecodingState decode(IoBuffer in, ProtocolDecoderOutput out) throws Exception {
37 if (in.hasRemaining()) {
38 return finishDecode(in.get(), out);
39 }
40
41 return this;
42 }
43
44 /**
45 * {@inheritDoc}
46 */
47 @Override
48 public DecodingState finishDecode(ProtocolDecoderOutput out) throws Exception {
49 throw new ProtocolDecoderException("Unexpected end of session while waiting for a single byte.");
50 }
51
52 /**
53 * Invoked when this state has consumed a complete <code>byte</code>.
54 *
55 * @param b the byte.
56 * @param out the current {@link ProtocolDecoderOutput} used to write
57 * decoded messages.
58 * @return the next state if a state transition was triggered (use
59 * <code>this</code> for loop transitions) or <code>null</code> if
60 * the state machine has reached its end.
61 * @throws Exception if the read data violated protocol specification.
62 */
63 protected abstract DecodingState finishDecode(byte b, ProtocolDecoderOutput out) throws Exception;
64 }