org.snf4j.core.codec.bytes

Class BufferToArrayDecoder

java.lang.Object

org.snf4j.core.codec.bytes.BufferToArrayCodec

org.snf4j.core.codec.bytes.BufferToArrayDecoder

All Implemented Interfaces:

ICodec<ByteBuffer,byte[]>, IDecoder<ByteBuffer,byte[]>

public class BufferToArrayDecoder
extends BufferToArrayCodec
implements IDecoder<ByteBuffer,byte[]>

A decoder transforming a ByteBuffer into an array of bytes.

Author:

SNF4J.ORG

Constructor Summary

Constructors

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

Method Summary

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

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

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

BufferToArrayDecoder

public BufferToArrayDecoder(boolean release)

Constructs a decoder with a specified buffer releasing mode.

Parameters:

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

BufferToArrayDecoder

public BufferToArrayDecoder()

Constructs a decoder with no buffer releasing.

Method Detail

decode

public void decode(ISession session,
                   ByteBuffer data,
                   List<byte[]> out)
            throws Exception

Description copied from interface: IDecoder

Decodes data from one type to another one.

Decoders 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 decoders that produce an output.

Specified by:

decode in interface IDecoder<ByteBuffer,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