org.snf4j.core.codec

Interface IEncoder<I,O>

Type Parameters:

I - the type of the accepted inbound objects

O - the type of the produced outbound objects, or Void if no output is produced (e.g. a logging codec)

All Superinterfaces:

ICodec<I,O>

All Known Implementing Classes:

ArrayToBufferEncoder, BufferToArrayEncoder, CompoundEncoder, EventDrivenCompoundEncoder, GzipEncoder, ZlibEncoder

public interface IEncoder<I,O>
extends ICodec<I,O>

A encoder that can be managed by a codec pipeline implementing the ICodecPipeline interface.

Author:

SNF4J.ORG

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 interface org.snf4j.core.codec.ICodec

getInboundType, getOutboundType

Method Detail

encode

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

Encodes data from one type to another one.

Encoders that do not produce an output (i.e. the O parameter is Void) cannot change the object passed as the data argument. They should not also store it for future use as its state can be changed.

The above limitations regarding the data argument do not apply to encoders that produce an output.

Parameters:

session - the ISession which the passed data belongs to

data - the data to decode to another one

out - the List to which the decoded data should be added, or null if O is Void

Throws:

Exception - is thrown, if an error occur