net.sf.eBus.messages.type

Class ConcreteMessageType

java.lang.Object

net.sf.eBus.messages.type.DataType

net.sf.eBus.messages.type.MessageType

net.sf.eBus.messages.type.ConcreteMessageType

All Implemented Interfaces:

Comparable<DataType>

public class ConcreteMessageType
extends MessageType

Base class for concrete message types. While this class itself is abstract it references a concrete message/field type.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ConcreteMessageType(Class<?> clazz, List<MessageType.MessageField> fields, List<Class<? extends EReplyMessage>> replies, Method builder, Class<? extends EMessageObject.Builder<?,?>> bc) Creates a new concrete message type instance.

Method Summary

Modifier and Type	Method and Description
Method	builder() Returns the static method which returns the message builder instance.
Class<? extends EMessageObject.Builder<?,?>>	builderClass() Returns the message object builder class.
String	builderClassName() Returns the message builder canonical name.
protected void	createDeserializer(MessageType.MessageField field, String fieldName, String indent, Formatter output, boolean useBuilder) Returns code for de-serializing a specified field.
protected void	createSerializer(MessageType.MessageField field, String fieldName, String indent, Formatter output) Returns code for serializing a specific field.
Object	deserialize(ByteBuffer buffer) Returns an EMessageObject extracted from the given buffer.
void	serialize(Object o, ByteBuffer buffer) Serializes the given EMessageObject to the given buffer.

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

Constructor Detail

ConcreteMessageType

protected ConcreteMessageType(Class<?> clazz,
                              List<MessageType.MessageField> fields,
                              List<Class<? extends EReplyMessage>> replies,
                              Method builder,
                              Class<? extends EMessageObject.Builder<?,?>> bc)

Creates a new concrete message type instance.

Parameters:

clazz - the message class instance.

fields - the message fields.

replies - reply classes associated with a request message class. Will be an empty array for non-request message types.

builder - message builder method.

bc - message builder class used for de-serialization.

Method Detail

serialize

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

Serializes the given EMessageObject to the given buffer.

Specified by:

serialize in class DataType

Parameters:

o - serialize this object.

buffer - contains serialized object.

Throws:

BufferOverflowException - if serialized o overflows buffer.

deserialize

public final Object deserialize(ByteBuffer buffer)
                         throws BufferUnderflowException,
                                ValidationException

Returns an EMessageObject extracted from the given buffer. This method expects the message subject to have been previously set if the serialized object is an EMessage.

Specified by:

deserialize in class DataType

Parameters:

buffer - extract the serialized object from this buffer.

Returns:

the de-serialized object.

Throws:

BufferUnderflowException - if buffer contains an incomplete object serialization.

ValidationException - if the serialized object is invalid.

createSerializer

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

Returns code for serializing a specific field. This always UnsupportedOperationException because this class must be extended and this method overridden.

Specified by:

createSerializer in class DataType

Parameters:

field - message field.

fieldName - generate serialization code for this field.

indent - indent code by this amount.

output - place generated code into this formatter.

Throws:

UnsupportedOperationException - because this method must be overridden by a subclass.

createDeserializer

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

Returns code for de-serializing a specified field. This always UnsupportedOperationException because this class must be extended and this method overridden.

Specified by:

createDeserializer in class DataType

Parameters:

field - message field.

fieldName - generate de-serialization code for this field.

indent - indent code by this amount.

output - place generated code into this formatter.

useBuilder - if true store de-serialized object in a builder; otherwise store in local variable named fieldName.

Throws:

UnsupportedOperationException - because this method must be overridden by a subclass.

builder

public Method builder()

Returns the static method which returns the message builder instance.

Returns:

builder static method.

builderClass

public Class<? extends EMessageObject.Builder<?,?>> builderClass()

Returns the message object builder class.

Returns:

message object builder class.

builderClassName

public String builderClassName()

Returns the message builder canonical name.

Returns:

message builder canonical name.