org.snf4j.core.codec

Class CompoundDecoder<I,O>

java.lang.Object

org.snf4j.core.codec.CompoundDecoder<I,O>

Type Parameters:

I - the type of the accepted inbound objects

O - the type of the produced outbound objects

All Implemented Interfaces:

ICodec<I,O>, IDecoder<I,O>

Direct Known Subclasses:

EventDrivenCompoundDecoder

public abstract class CompoundDecoder<I,O>
extends Object
implements IDecoder<I,O>

A compound decoder that processes input data through a chain of the specified decoders.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
CompoundDecoder(IDecoder<?,?>... decoders) Constructs a compound decoder with a chain of the specified decoders.

Method Summary

Modifier and Type	Method and Description
void	decode(ISession session, I data, List<O> out) Decodes data from one type to another one.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.snf4j.core.codec.ICodec

getInboundType, getOutboundType

Constructor Detail

CompoundDecoder

public CompoundDecoder(IDecoder<?,?>... decoders)

Constructs a compound decoder with a chain of the specified decoders.

The decoder chain is organized in the following way:

 {data} -> decoder1 -> decoder2 -> ... -> decoderN -> {out}
 

Parameters:

decoders - the chain of decoders

Throws:

IllegalArgumentException - if the specified decoders have incompatible inbound or outbound types

IllegalStateException - if the param O is Void

Method Detail

decode

public final void decode(ISession session,
                         I data,
                         List<O> out)
                  throws Exception

Decodes data from one type to another one.

Specified by:

decode in interface IDecoder<I,O>

Parameters:

out - the List to which the decoded data should be added

session - the ISession which the passed data belongs to

data - the data to decode to another one

Throws:

Exception - is thrown, if an error occur