biz.onixs.fix.fast

Class Decoder

java.lang.Object

biz.onixs.fix.fast.Coder

biz.onixs.fix.fast.Decoder

public class Decoder
extends Coder

FAST-to-FIX Decoder.

Constructor Summary

Constructors

Constructor and Description
Decoder(InputStream templateStream, FastVersion fastVersion, Version fixVersion) Constructor.
Decoder(InputStream templateStream, FastVersion fastVersion, Version fixVersion, boolean codeEachMessageIndependently) Constructor.
Decoder(InputStream templateStream, Version fixVersion) Constructor.
Decoder(InputStream templateStream, Version fixVersion, boolean codeEachMessageIndependently) Constructor.

Method Summary

Modifier and Type	Method and Description
Message	decode(byte[] buffer) Decodes the given FAST stream chunk into the corresponding FIX Message.
Message	decode(byte[] buffer, int offset) Decodes the given FAST stream chunk into the corresponding FIX Message.
Message	decode(byte[] buffer, int offset, int count) Decodes the given FAST stream chunk into the corresponding FIX Message.
Message	decode(ByteBuffer buffer) Decodes the given FAST stream chunk into the corresponding FIX Message.
Message	decode(ByteBuffer buffer, int offset) Decodes the given FAST stream chunk into the corresponding FIX Message.
void	decode(DecodeResult result, byte[] buffer) Decodes the given FAST stream chunk into the corresponding FIX Message.
void	decode(DecodeResult result, byte[] buffer, int offset) Decodes the given FAST stream chunk into the corresponding FIX Message.
void	decode(DecodeResult result, byte[] buffer, int offset, int count) Decodes the given FAST stream chunk into the corresponding FIX Message.
void	decode(DecodeResult result, ByteBuffer buffer) Decodes the given FAST stream chunk into the corresponding FIX Message.
void	decode(DecodeResult result, ByteBuffer buffer, int offset) Decodes the given FAST stream chunk into the corresponding FIX Message.
static DecodedValue<byte[]>	decodeByteVector(byte[] buffer, int offset) Decodes FAST non-nullable byte vector value.
static DecodedValue<byte[]>	decodeByteVector(byte[] buffer, int offset, int count) Decodes FAST non-nullable byte vector value.
static DecodedValue<Integer>	decodeInt32(byte[] buffer, int offset) Decodes FAST non-nullable Int32 value.
static DecodedValue<Integer>	decodeInt32(byte[] buffer, int offset, int count) Decodes FAST non-nullable Int32 value.
static DecodedValue<UnsignedInteger>	decodeUInt32(byte[] buffer, int offset) Decodes FAST non-nullable uInt32 value.
static DecodedValue<UnsignedInteger>	decodeUInt32(byte[] buffer, int offset, int count) Decodes FAST non-nullable uInt32 value.
FixMessageFactory	getFixMessageFactory() Returns message factory to use for creating decoded FIX message instance.
int	getMaximumNumberOfRepeatingGroupEntries() Returns maximum allowed number of repeating group entries.
void	setFixMessageFactory(FixMessageFactory messageFactory) Sets message factory to use for creating decoded FIX message instance.
void	setMaximumNumberOfRepeatingGroupEntries(int maximumNumberOfRepeatingGroupEntries) Sets maximum allowed number of repeating group entries.

Methods inherited from class biz.onixs.fix.fast.Coder

getFastVersion, getFixVersion, isCodeEachMessageIndependently, reset, updateMissedIdentifiers

Methods inherited from class java.lang.Object

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

Constructor Detail

Decoder

public Decoder(InputStream templateStream,
               Version fixVersion)

Constructor.

Parameters:

templateStream - input stream with the FAST template XML

fixVersion - target FIX version

Decoder

public Decoder(InputStream templateStream,
               FastVersion fastVersion,
               Version fixVersion)

Constructor.

Parameters:

templateStream - input stream with the FAST template XML

fastVersion - source FAST version, default is FastVersion.FAST_1_1

fixVersion - target FIX version

Decoder

public Decoder(InputStream templateStream,
               Version fixVersion,
               boolean codeEachMessageIndependently)

Constructor.

Parameters:

templateStream - input stream with the FAST template XML

fixVersion - target FIX version

codeEachMessageIndependently - option to reset the previous values dictionaries, default is true

Decoder

public Decoder(InputStream templateStream,
               FastVersion fastVersion,
               Version fixVersion,
               boolean codeEachMessageIndependently)

Constructor.

Parameters:

templateStream - input stream with the FAST template XML

fastVersion - source FAST version, default is FastVersion.FAST_1_1

fixVersion - target FIX version

codeEachMessageIndependently - option to reset the previous values dictionaries, default is true

Method Detail

getMaximumNumberOfRepeatingGroupEntries

public int getMaximumNumberOfRepeatingGroupEntries()

Returns maximum allowed number of repeating group entries.

If the limit is exceeded then the exception is thrown. The default value is 1000.

Returns:

max number of repeating group entries

setMaximumNumberOfRepeatingGroupEntries

public void setMaximumNumberOfRepeatingGroupEntries(int maximumNumberOfRepeatingGroupEntries)

Sets maximum allowed number of repeating group entries. If the limit is exceeded then the exception is thrown. The default value is 1000.

Parameters:

maximumNumberOfRepeatingGroupEntries - max number of repeating group entries

getFixMessageFactory

public FixMessageFactory getFixMessageFactory()

Returns message factory to use for creating decoded FIX message instance.

Returns:

FIX message factory

setFixMessageFactory

public void setFixMessageFactory(FixMessageFactory messageFactory)

Sets message factory to use for creating decoded FIX message instance.

Parameters:

messageFactory - FIX message factory

decode

public Message decode(ByteBuffer buffer)

Decodes the given FAST stream chunk into the corresponding FIX Message.

Parameters:

buffer - an array of bytes that contains the source FAST stream chunk

Returns:

decoded FIX message or null if message cannot be decoded due to data shortage

Throws:

FastException - if error occurs

decode

public Message decode(ByteBuffer buffer,
                      int offset)

Decodes the given FAST stream chunk into the corresponding FIX Message.

Parameters:

buffer - an array of bytes that contains the source FAST stream chunk

offset - the zero-based byte offset in buffer at which to begin decoding

Returns:

decoded FIX message or null if message cannot be decoded due to data shortage

Throws:

FastException - if error occurs

decode

public Message decode(byte[] buffer,
                      int offset,
                      int count)

Decodes the given FAST stream chunk into the corresponding FIX Message.

Parameters:

buffer - an array of bytes that contains the source FAST stream chunk

offset - the zero-based byte offset in buffer at which to begin decoding

count - the number of bytes to process

Returns:

decoded FIX message or null if message cannot be decoded due to data shortage

Throws:

FastException - if error occurs

decode

public Message decode(byte[] buffer,
                      int offset)

Decodes the given FAST stream chunk into the corresponding FIX Message.

Parameters:

buffer - input FAST data

offset - the number of bytes from the beginning of the byte array to skip

Returns:

decoded FIX message or null if message cannot be decoded due to data shortage

Throws:

FastException - if decoding failed

decode

public Message decode(byte[] buffer)

Decodes the given FAST stream chunk into the corresponding FIX Message.

Parameters:

buffer - an array of bytes that contains the source FAST stream chunk

Returns:

decoded FIX message or null if message cannot be decoded due to data shortage

Throws:

FastException - if decoding failed

decode

public void decode(DecodeResult result,
                   ByteBuffer buffer)

Decodes the given FAST stream chunk into the corresponding FIX Message.

The result parameter contains the decoded message or null if message cannot be decoded due to data shortage.

Parameters:

result - decode result to fill

buffer - an array of bytes that contains the source FAST stream chunk

Throws:

FastException - if error occurs

decode

public void decode(DecodeResult result,
                   ByteBuffer buffer,
                   int offset)

Decodes the given FAST stream chunk into the corresponding FIX Message.

The result parameter contains the decoded message or null if message cannot be decoded due to data shortage.

Parameters:

result - decode result to fill

buffer - an array of bytes that contains the source FAST stream chunk

offset - the zero-based byte offset in buffer at which to begin decoding

Throws:

FastException - if error occurs

decode

public void decode(DecodeResult result,
                   byte[] buffer,
                   int offset,
                   int count)

Decodes the given FAST stream chunk into the corresponding FIX Message.

Parameters:

result - decode result to fill

buffer - an array of bytes that contains the source FAST stream chunk

offset - the zero-based byte offset in buffer at which to begin decoding

count - the number of bytes to process

Throws:

FastException - if error occurs

decode

public void decode(DecodeResult result,
                   byte[] buffer,
                   int offset)

Decodes the given FAST stream chunk into the corresponding FIX Message.

The result parameter contains the decoded message or null if message cannot be decoded due to data shortage.

Parameters:

result - decode result to fill

buffer - input FAST data

offset - the number of bytes from the beginning of the byte array to skip

Throws:

FastException - if decoding failed

decode

public void decode(DecodeResult result,
                   byte[] buffer)

Decodes the given FAST stream chunk into the corresponding FIX Message.

The result parameter contains the decoded message or null if message cannot be decoded due to data shortage.

Parameters:

result - decode result to fill

buffer - an array of bytes that contains the source FAST stream chunk

Throws:

FastException - if decoding failed

decodeInt32

public static DecodedValue<Integer> decodeInt32(byte[] buffer,
                                                int offset)

Decodes FAST non-nullable Int32 value.

Parameters:

buffer - encoded data

offset - offset in the buffer

Returns:

decoded value

Throws:

NullPointerException - if (buffer == null)

IllegalArgumentException - if (buffer.length == 0) || (offset < 0) || (offset >= buffer.length)

NotEnoughInputDataException - if the buffer has not enough data to decode an integer value.

decodeInt32

public static DecodedValue<Integer> decodeInt32(byte[] buffer,
                                                int offset,
                                                int count)

Decodes FAST non-nullable Int32 value.

Parameters:

buffer - encoded data

offset - offset in the buffer

count - number of bytes to use

Returns:

decoded value

Throws:

NullPointerException - if (buffer == null)

IllegalArgumentException - if (buffer.length == 0) || (offset < 0) || (offset >= buffer.length) || (count + offset) >= buffer.length

NotEnoughInputDataException - if the specified count of bytes has not enough data to decode an integer value.

decodeUInt32

public static DecodedValue<UnsignedInteger> decodeUInt32(byte[] buffer,
                                                         int offset)

Decodes FAST non-nullable uInt32 value.

Parameters:

buffer - encoded data

offset - offset in the buffer

Returns:

decoded value

Throws:

NullPointerException - if (buffer == null)

IllegalArgumentException - if (buffer.length == 0) || (offset < 0) || (offset >= buffer.length) || (count + offset) >= buffer.length

NotEnoughInputDataException - if the buffer has not enough data to decode an integer value.

decodeUInt32

public static DecodedValue<UnsignedInteger> decodeUInt32(byte[] buffer,
                                                         int offset,
                                                         int count)

Decodes FAST non-nullable uInt32 value.

Parameters:

buffer - encoded data

offset - offset in the buffer

count - number of bytes to use

Returns:

decoded value

Throws:

NullPointerException - if (buffer == null)

IllegalArgumentException - if (buffer.length == 0) || (offset < 0) || (offset >= buffer.length) || (count + offset) >= buffer.length

NotEnoughInputDataException - if the specified count of bytes has not enough data to decode an integer value.

decodeByteVector

public static DecodedValue<byte[]> decodeByteVector(byte[] buffer,
                                                    int offset)

Decodes FAST non-nullable byte vector value.

Parameters:

buffer - encoded data

offset - offset in the buffer

Returns:

decoded value

Throws:

NullPointerException - if (buffer == null)

IllegalArgumentException - if (buffer.length == 0) || (offset < 0) || (offset >= buffer.length) || (count + offset) >= buffer.length

NotEnoughInputDataException - if the buffer has not enough data to decode a byte vector.

decodeByteVector

public static DecodedValue<byte[]> decodeByteVector(byte[] buffer,
                                                    int offset,
                                                    int count)

Decodes FAST non-nullable byte vector value.

Parameters:

buffer - encoded data

offset - offset in the buffer

count - number of bytes to use

Returns:

decoded value

Throws:

NullPointerException - if (buffer == null)

IllegalArgumentException - if (buffer.length == 0) || (offset < 0) || (offset >= buffer.length) || (count + offset) >= buffer.length

NotEnoughInputDataException - if the specified count of bytes has not enough data to decode a byte vector.