org.snf4j.example.echo

Class Encoder

java.lang.Object

org.snf4j.example.echo.Encoder

All Implemented Interfaces:

ICodec<ByteBuffer,ByteBuffer>, IEncoder<ByteBuffer,ByteBuffer>

public class Encoder
extends Object
implements IEncoder<ByteBuffer,ByteBuffer>

Constructor Summary

Constructors

Constructor and Description
Encoder()

Method Summary

Modifier and Type	Method and Description
void	encode(ISession session, ByteBuffer data, List<ByteBuffer> out) Encodes data from one type to another one.
Class<ByteBuffer>	getInboundType() Returns the type of the accepted inbound objects.
Class<ByteBuffer>	getOutboundType() Returns the type of the produced outbound objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

Encoder

public Encoder()

Method Detail

getInboundType

public Class<ByteBuffer> getInboundType()

Description copied from interface: ICodec

Returns the type of the accepted inbound objects.

Specified by:

getInboundType in interface ICodec<ByteBuffer,ByteBuffer>

Returns:

the type of the inbound objects

getOutboundType

public Class<ByteBuffer> getOutboundType()

Description copied from interface: ICodec

Returns the type of the produced outbound objects.

Specified by:

getOutboundType in interface ICodec<ByteBuffer,ByteBuffer>

Returns:

the type of the outbound objects

encode

public void encode(ISession session,
                   ByteBuffer data,
                   List<ByteBuffer> out)
            throws Exception

Description copied from interface: IEncoder

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.

Specified by:

encode in interface IEncoder<ByteBuffer,ByteBuffer>

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