net.sf.eBus.messages.type

Class FieldListType

java.lang.Object

net.sf.eBus.messages.type.DataType

net.sf.eBus.messages.type.FieldListType

All Implemented Interfaces:

Comparable<DataType>

public final class FieldListType
extends DataType

Provides binary serialization/de-serialization for EFieldList. The serialized field list format is:

EMessageList Serialization Layout

Position	Size (bytes)	Description
0	2	Message list size
2	m	field class name
2+m	n	Each EField in list

Author:

Charles W. Rapp

Field Summary

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) Adds the Java code used to de-serialize a field list from a ByteBuffer.
protected void	createSerializer(MessageType.MessageField field, String fieldName, String indent, Formatter output) Adds the Java code used to serialize a field list to a ByteBuffer.
Object	deserialize(ByteBuffer buffer) Returns the field list instance de-serialized from the given buffer.
void	serialize(Object o, ByteBuffer buffer) Serializes the EFieldList instance to buffer.

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 EFieldList instance to buffer. The serialize format is show in EFieldListType class documentation.

Specified by:

serialize in class DataType

Parameters:

o - a EFieldList instance.

buffer - write output to this buffer.

Throws:

BufferOverflowException - if buffer does not have sufficient space to store the serialized message list.

deserialize

public Object deserialize(ByteBuffer buffer)
                   throws BufferUnderflowException

Returns the field list instance de-serialized from the given buffer.

Specified by:

deserialize in class DataType

Parameters:

buffer - read in the field list instance from this buffer.

Returns:

de-serialized field list.

Throws:

BufferUnderflowException - if buffer contains an incomplete field list.

createSerializer

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

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

Specified by:

createSerializer in class DataType

Parameters:

field - message field.

fieldName - field list field name.

indent - indent the code by this white space.

output - write the code to this formatter.

createDeserializer

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

Adds the Java code used to de-serialize a field list from a ByteBuffer.

Specified by:

createDeserializer in class DataType

Parameters:

field - message field.

fieldName - field list field name.

indent - indent code by this white space.

output - write the code to this formatter.

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