com.cinnober.msgcodec.blink

Class GeneratedCodec

java.lang.Object

com.cinnober.msgcodec.blink.GeneratedCodec

public abstract class GeneratedCodec
extends java.lang.Object

Base class for a dynamically generated codec for a specific dictionary. There is also a sub class which does not use dynamically generated byte code; InstructionCodec. A GeneratedCodec sub class represents a dictionary. A GeneratedCodec instance is tied to a specific BlinkCodec instance which holds the encode buffers and any max binary size settings.

Field Summary

Fields

Modifier and Type	Field and Description
protected BlinkCodec	codec Reference to the blink codec.

Constructor Summary

Constructors

Constructor and Description
GeneratedCodec(BlinkCodec codec) Constructor.

Method Summary

Modifier and Type	Method and Description
protected static java.lang.IllegalArgumentException	missingRequiredValue(java.lang.String valueName) Create an encode exception when a required value is missing.
java.lang.Object	readDynamicGroup(com.cinnober.msgcodec.util.LimitInputStream in) Read a dynamic group.
java.lang.Object	readDynamicGroupNull(com.cinnober.msgcodec.util.LimitInputStream in) Read a nullable dynamic group.
protected abstract java.lang.Object	readStaticGroup(int groupId, com.cinnober.msgcodec.util.LimitInputStream in) Read a static group.
protected static com.cinnober.msgcodec.DecodeException	unknownEnumSymbol(java.lang.String valueName, int symbolId) Create a decode exception when an unknown enum symbol id is read.
protected static com.cinnober.msgcodec.DecodeException	unknownGroupId(int groupId) Create a decode exception when an unknown group id is read.
protected static java.lang.IllegalArgumentException	unknownGroupType(java.lang.Object groupType) Create an encode exception when trying to encode a group for an unknown group type.
protected static com.cinnober.msgcodec.DecodeException	unmappableEnumSymbolId(java.lang.String valueName, int symbolId, java.lang.Class<? extends java.lang.Enum> enumClass) Create a decode exception when an unmappable enum symbol id is read.
protected static <E extends java.lang.Enum<E>> java.lang.IllegalArgumentException	unmappableEnumSymbolValue(java.lang.String valueName, E enumValue) Create an encode exception when an unmappable enum value is found.
void	writeDynamicGroup(java.io.OutputStream out, java.lang.Object group) Write a dynamic group to the specified output stream.
void	writeDynamicGroupNull(java.io.OutputStream out, java.lang.Object group) Write a nullable dynamic group to the specified output stream.
protected abstract void	writeStaticGroupWithId(java.io.OutputStream out, java.lang.Object group) Write a static group and its group id.

Methods inherited from class java.lang.Object

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

Field Detail

codec

protected final BlinkCodec codec

Reference to the blink codec.

Constructor Detail

GeneratedCodec

public GeneratedCodec(BlinkCodec codec)

Constructor. The constructor of the subclass should have the signature (BlinkCodec, ProtocolDictionary).

Parameters:

codec - the blink codec, not null.

Method Detail

writeStaticGroupWithId

protected abstract void writeStaticGroupWithId(java.io.OutputStream out,
                                               java.lang.Object group)
                                        throws java.io.IOException,
                                               java.lang.IllegalArgumentException

Write a static group and its group id. Method to be generated in a sub class using switch construct (similar what is generated for a switch on String) based on the group type.

Parameters:

out - where to write to, not null

group - the group to write, not null.

Throws:

java.io.IOException - if the underlying stream throws an exception.

java.lang.IllegalArgumentException - if an illegal value is encountered, e.g. missing required field value.

readStaticGroup

protected abstract java.lang.Object readStaticGroup(int groupId,
                                                    com.cinnober.msgcodec.util.LimitInputStream in)
                                             throws java.io.IOException,
                                                    com.cinnober.msgcodec.DecodeException

Read a static group. Method to be generated in a sub class using switch based on group id.

Parameters:

groupId - the group id

in - where to read from, not null.

Returns:

the decoded group, not null.

Throws:

java.io.IOException - if the underlying stream throws an exception.

com.cinnober.msgcodec.DecodeException - if the group could not be decoded.

writeDynamicGroup

public void writeDynamicGroup(java.io.OutputStream out,
                              java.lang.Object group)
                       throws java.io.IOException,
                              java.lang.IllegalArgumentException

Write a dynamic group to the specified output stream.

Parameters:

out - where to write to, not null.

group - the group to encode, not null

Throws:

java.io.IOException - if the underlying stream throws an exception.

java.lang.IllegalArgumentException

writeDynamicGroupNull

public void writeDynamicGroupNull(java.io.OutputStream out,
                                  java.lang.Object group)
                           throws java.io.IOException

Write a nullable dynamic group to the specified output stream.

Parameters:

out - where to write to, or null.

group - the group to encode, not null

Throws:

java.io.IOException - if the underlying stream throws an exception.

readDynamicGroup

public java.lang.Object readDynamicGroup(com.cinnober.msgcodec.util.LimitInputStream in)
                                  throws java.io.IOException

Read a dynamic group.

Parameters:

in - the stream to read from.

Returns:

the group, not null.

Throws:

java.io.IOException - if the underlying stream throws an exception.

readDynamicGroupNull

public java.lang.Object readDynamicGroupNull(com.cinnober.msgcodec.util.LimitInputStream in)
                                      throws java.io.IOException

Read a nullable dynamic group.

Parameters:

in - the stream to read from.

Returns:

the group, or null.

Throws:

java.io.IOException - if the underlying stream throws an exception.

missingRequiredValue

protected static java.lang.IllegalArgumentException missingRequiredValue(java.lang.String valueName)

Create an encode exception when a required value is missing.

Parameters:

valueName - the name of the value, e.g. a field name, not null.

Returns:

the exception to be thrown.

unmappableEnumSymbolId

protected static com.cinnober.msgcodec.DecodeException unmappableEnumSymbolId(java.lang.String valueName,
                                                                              int symbolId,
                                                                              java.lang.Class<? extends java.lang.Enum> enumClass)

Create a decode exception when an unmappable enum symbol id is read. This means that for a given valid symbol id, there is no Java enum value.

Parameters:

valueName - the name of the value, e.g. a field name, not null.

symbolId - the symbol id

enumClass - the enum class, not null

Returns:

the exception to be thrown.

unknownEnumSymbol

protected static com.cinnober.msgcodec.DecodeException unknownEnumSymbol(java.lang.String valueName,
                                                                         int symbolId)

Create a decode exception when an unknown enum symbol id is read.

Parameters:

valueName - the name of the value, e.g. a field name, not null.

symbolId - the symbol id

Returns:

the exception to be thrown.

unmappableEnumSymbolValue

protected static <E extends java.lang.Enum<E>> java.lang.IllegalArgumentException unmappableEnumSymbolValue(java.lang.String valueName,
                                                                                                            E enumValue)

Create an encode exception when an unmappable enum value is found. This means that for a given Java enum value, there is no mapping to a symbol id.

Type Parameters:

E - the enum type

Parameters:

valueName - the name of the value, e.g. a field name, not null.

enumValue - the unmappable unum value, not null

Returns:

the exception to be thrown.

unknownGroupType

protected static java.lang.IllegalArgumentException unknownGroupType(java.lang.Object groupType)

Create an encode exception when trying to encode a group for an unknown group type. This mean that the group is not present in the dictionary.

Parameters:

groupType - the group type (e.g. a java class) of the group to be encoded, not null.

Returns:

the exception to be thrown.

unknownGroupId

protected static com.cinnober.msgcodec.DecodeException unknownGroupId(int groupId)

Create a decode exception when an unknown group id is read.

Parameters:

groupId - the group id.

Returns:

the exception to be thrown.