net.sf.eBus.messages.type

Class LocalMessageType

java.lang.Object

net.sf.eBus.messages.type.DataType

net.sf.eBus.messages.type.MessageType

net.sf.eBus.messages.type.LocalMessageType

All Implemented Interfaces:

Comparable<DataType>

public final class LocalMessageType
extends MessageType

This type defines EMessageObject sub-classes which are annotated with ELocalOnly. This means that the message will not be serialized for remote transmission but instead is used only within a JVM. Because of this, local message fields are not collected. If the underlying type is a request message, then the supported reply message types are collected.

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) Does nothing since local-only message objects are not serialized or de-serialized.
protected void	createSerializer(MessageType.MessageField field, String fieldName, String indent, Formatter output) Does nothing since local-only message objects are not serialized or de-serialized.
Object	deserialize(ByteBuffer buffer) Does nothing since local-only message objects are not serialized or de-serialized.
void	serialize(Object o, ByteBuffer buffer) Does nothing since local-only message objects are not serialized or de-serialized.

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

Does nothing since local-only message objects are not serialized or de-serialized.

Specified by:

serialize in class DataType

Parameters:

o - serialize this message object.

buffer - place serialized message object into this buffer.

Throws:

BufferOverflowException - is never thrown since no data is written to buffer.

UnsupportedOperationException - since this operation is not supported for local-only message objects.

deserialize

public Object deserialize(ByteBuffer buffer)
                   throws BufferUnderflowException,
                          ValidationException

Does nothing since local-only message objects are not serialized or de-serialized.

Specified by:

deserialize in class DataType

Parameters:

buffer - read on serialized message from this buffer.

Returns:

never returns

Throws:

BufferUnderflowException - is never thrown since no data is read from buffer.

ValidationException - if never thrown since no message object is de-serialized.

UnsupportedOperationException - since this operation is not supported for local-only message objects.

createSerializer

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

Does nothing since local-only message objects are not serialized or de-serialized.

Specified by:

createSerializer in class DataType

Parameters:

field - generate serializer code for this field.

fieldName - serialized message field.

indent - indent generated code by this amount.

output - place generated code into this formatter.

Throws:

UnsupportedOperationException - since this operation is not supported for local-only message objects.

createDeserializer

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

Does nothing since local-only message objects are not serialized or de-serialized.

Specified by:

createDeserializer in class DataType

Parameters:

field - generate de-serializer code for this field.

fieldName - field name.

indent - indent generated code by this amount.

output - place generated code into this formatter.

useBuilder - if true place de-serialized message object into builder; otherwise into a local variable.

Throws:

UnsupportedOperationException - since this operation is not supported for local-only message objects.