org.apache.mina.filter.codec.statemachine.SingleByteDecodingState Maven / Gradle / Ivy
/**
* Copyright 2007-2015, Kaazing Corporation. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.mina.filter.codec.statemachine;
import org.apache.mina.core.buffer.IoBuffer;
import org.apache.mina.filter.codec.ProtocolDecoderException;
import org.apache.mina.filter.codec.ProtocolDecoderOutput;
/**
* {@link DecodingState} which decodes byte
values.
*
* @author Apache MINA Project
*/
public abstract class SingleByteDecodingState implements DecodingState {
public DecodingState decode(IoBuffer in, ProtocolDecoderOutput out)
throws Exception {
if (in.hasRemaining()) {
return finishDecode(in.get(), out);
}
return this;
}
/**
* {@inheritDoc}
*/
public DecodingState finishDecode(ProtocolDecoderOutput out)
throws Exception {
throw new ProtocolDecoderException(
"Unexpected end of session while waiting for a single byte.");
}
/**
* Invoked when this state has consumed a complete byte
.
*
* @param b the byte.
* @param out the current {@link ProtocolDecoderOutput} used to write
* decoded messages.
* @return the next state if a state transition was triggered (use
* this
for loop transitions) or null
if
* the state machine has reached its end.
* @throws Exception if the read data violated protocol specification.
*/
protected abstract DecodingState finishDecode(byte b,
ProtocolDecoderOutput out) throws Exception;
}