net.sf.eBus.messages.type

Class AbstractMessageType

java.lang.Object

net.sf.eBus.messages.type.DataType

net.sf.eBus.messages.type.MessageType

net.sf.eBus.messages.type.AbstractMessageType

All Implemented Interfaces:

Comparable<DataType>

public final class AbstractMessageType
extends MessageType

This non-abstract class is used for abstract EMessageObject classes. This message type allows an EMessage and EField types to contains abstract message fields. This allows a single message class to be used for a range of field types. The downside is that message serialization and de-serialization is slowed due to the need to place the concrete class name in the serialized message.

Author:

Charles W. Rapp

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.eBus.messages.type.MessageType

MessageType.MessageField

Field Summary

Fields inherited from class net.sf.eBus.messages.type.MessageType

BUILD_INNER_CLASS, BUILDER_METHOD, mFields, mReplyClasses, mSubject, PUBLIC_FINAL, PUBLIC_STATIC, SUBJECT_FIELD

Fields inherited from class net.sf.eBus.messages.type.DataType

ADDRESS_TYPE, ARRAY_SUFFIX, CHARSET, CLASS_TYPE, EMPTY_STRING, FIELD_MASK_SIZE, INDENT, INDENT1, KEY_TYPE, MAX_ARRAY_SIZE, MAX_FIELDS, MAX_FILE_NAME_LENGTH, MAX_STRING_LENGTH, mBuiltinFlag, mClass, mDefaultValue, mSize, sClasses, sCompiledClasses, STRING_TYPE, VARIABLE_SIZE

Method Summary

Modifier and Type	Method and Description
protected void	createDeserializer(MessageType.MessageField field, String fieldName, String indent, Formatter output, boolean useBuilder) Generates the code to de-serialize the named field from a ByteBuffer.
protected void	createSerializer(MessageType.MessageField field, String fieldName, String indent, Formatter output) Adds the Java code used to serialize the named field to a ByteBuffer.
Object	deserialize(ByteBuffer buffer) Returns a message object de-serialized from the given buffer.
void	serialize(Object o, ByteBuffer buffer) Serializes the message fields to the given the buffer, setting the field mask.

Methods inherited from class net.sf.eBus.messages.type.MessageType

deserializeFields, fields, findFields, isValidReply, numberFields, replyTypes, serializeFields, subject, values

Methods inherited from class net.sf.eBus.messages.type.DataType

compareTo, dataClass, dataClassName, defaultValue, equals, fields, findCharset, findType, hashCode, isArray, isBuiltin, isEnum, isInstance, isLocalOnly, isMessage, isPrimitive, replyClasses, size, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

serialize

public void serialize(Object o,
                      ByteBuffer buffer)
               throws BufferOverflowException

Serializes the message fields to the given the buffer, setting the field mask.

Note: as of eBus 4.4.0, messages are automatically compiled when first used for serialization or de-serialization. This increases the time it takes to send or receive a message the first time. When a message is frequently transmitted, it is recommended that the message class is "compiled" by calling DataType.findType(java.lang.Class) for that message class. So when a message is sent or received the first time, the message compilation is already done.

Specified by:

serialize in class DataType

Parameters:

o - serialize this message object.

buffer - write to this buffer.

Throws:

BufferOverflowException - if buffer does not contain sufficient space to store the message.

deserialize

public Object deserialize(ByteBuffer buffer)
                   throws IllegalStateException,
                          BufferUnderflowException,
                          UnknownMessageException,
                          ValidationException

Returns a message object de-serialized from the given buffer.

Note: as of eBus 4.4.0, messages are automatically compiled when first used for serialization or de-serialization. This increases the time it takes to send or receive a message the first time. When a message is frequently transmitted, it is recommended that the message class is "compiled" by calling DataType.findType(java.lang.Class) for that message class. So when a message is sent or received the first time, the message compilation is already done.

Specified by:

deserialize in class DataType

Parameters:

buffer - read in the message from this buffer.

Returns:

the de-serialized message.

Throws:

IllegalStateException - if MessageType.subject(String) was not called prior to de-serializing.

BufferUnderflowException - if buffer contains an incomplete message.

UnknownMessageException - if the serialized message is unknown to this eBus.

ValidationException - if the message is incorrectly serialized.

createSerializer

protected void createSerializer(MessageType.MessageField field,
                                String fieldName,
                                String indent,
                                Formatter output)

Adds the Java code used to serialize the named field to a ByteBuffer.

Specified by:

createSerializer in class DataType

Parameters:

field - message field.

fieldName - the message field name.

indent - indent the code by this amount.

output - write the code to this formatter.

createDeserializer

protected void createDeserializer(MessageType.MessageField field,
                                  String fieldName,
                                  String indent,
                                  Formatter output,
                                  boolean useBuilder)

Generates the code to de-serialize the named field from a ByteBuffer.

Specified by:

createDeserializer in class DataType

Parameters:

field - message field.

fieldName - store the de-serialized field in this name.

indent - indent the code by this amount.

output - append the code to this formatter.

useBuilder - if true then fieldName is a builder method name; otherwise a local variable.