org.snf4j.core.codec.bytes

Class BufferHolderToArrayEncoder

java.lang.Object

org.snf4j.core.codec.bytes.BufferHolderToArrayCodec

org.snf4j.core.codec.bytes.BufferHolderToArrayEncoder

All Implemented Interfaces:

ICodec<IByteBufferHolder,byte[]>, IEncoder<IByteBufferHolder,byte[]>

public class BufferHolderToArrayEncoder
extends BufferHolderToArrayCodec
implements IEncoder<IByteBufferHolder,byte[]>

A encoder transforming an IByteBufferHolder into an array of bytes.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
BufferHolderToArrayEncoder() Constructs a decoder with no buffer releasing.
BufferHolderToArrayEncoder(boolean release) Constructs a encoder with a specified buffer releasing mode.

Method Summary

Modifier and Type	Method and Description
void	encode(ISession session, IByteBufferHolder data, List<byte[]> out) Encodes data from one type to another one.

Methods inherited from class org.snf4j.core.codec.bytes.BufferHolderToArrayCodec

getInboundType, getOutboundType, toArray

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

BufferHolderToArrayEncoder

public BufferHolderToArrayEncoder(boolean release)

Constructs a encoder with a specified buffer releasing mode.

Parameters:

release - the releasing mode determining if buffers in the input buffer holder should be released by the session's allocator

BufferHolderToArrayEncoder

public BufferHolderToArrayEncoder()

Constructs a decoder with no buffer releasing.

Method Detail

encode

public void encode(ISession session,
                   IByteBufferHolder data,
                   List<byte[]> 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<IByteBufferHolder,byte[]>

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