org.snf4j.core.codec

Class CompoundEncoder<I,O>

java.lang.Object

org.snf4j.core.codec.CompoundEncoder<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>, IEncoder<I,O>

Direct Known Subclasses:

EventDrivenCompoundEncoder

public abstract class CompoundEncoder<I,O>
extends Object
implements IEncoder<I,O>

A compound encoder that processes input data through a chain of the specified encoders.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
CompoundEncoder(IEncoder<?,?>... encoders) Constructs a compound encoder with a chain of the specified encoders.

Method Summary

Modifier and Type	Method and Description
void	encode(ISession session, I data, List<O> out) Encodes 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

CompoundEncoder

public CompoundEncoder(IEncoder<?,?>... encoders)

Constructs a compound encoder with a chain of the specified encoders.

The encoder chain is organized in the following way:

 {data} -> encoder1 -> encoder2 -> ... -> encoderN -> {out}
 

Parameters:

encoders - the chain of encoders

Throws:

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

IllegalStateException - if the param O is Void

Method Detail

encode

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

Encodes data from one type to another one.

Specified by:

encode in interface IEncoder<I,O>

Parameters:

out - the List to which the encoded 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