org.snf4j.core.codec.bytes

Class ArrayToBufferDecoder

java.lang.Object

org.snf4j.core.codec.bytes.ArrayToBufferCodec

org.snf4j.core.codec.bytes.ArrayToBufferDecoder

All Implemented Interfaces:

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

public class ArrayToBufferDecoder
extends ArrayToBufferCodec
implements IDecoder<byte[],ByteBuffer>

A decoder transforming an array of bytes into a ByteBuffer.

Author:

SNF4J.ORG

Constructor Summary

Constructors

Constructor and Description
ArrayToBufferDecoder() Constructs a decoder with no buffer allocation (only by wrapping the input array)
ArrayToBufferDecoder(boolean allocate) Constructs a decoder with a specified allocation mode.

Method Summary

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

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

getInboundType, getOutboundType

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

ArrayToBufferDecoder

public ArrayToBufferDecoder(boolean allocate)

Constructs a decoder with a specified allocation mode.

Parameters:

allocate - the allocation mode determining if the output buffer should be allocated by the session's allocator or the buffer should wrap the input array.

ArrayToBufferDecoder

public ArrayToBufferDecoder()

Constructs a decoder with no buffer allocation (only by wrapping the input array)

Method Detail

decode

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