net.sf.eBus.messages.type

Class InetAddressType

java.lang.Object

net.sf.eBus.messages.type.DataType

net.sf.eBus.messages.type.InetAddressType

All Implemented Interfaces:

Comparable<DataType>

public final class InetAddressType
extends DataType

This class is able to serialize and de-serialize an InetAddress which may be either an IPv4 or IPv6 address.

Author:

Charles 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) Generates the class de-serialization code storing the result according to the useBuilder flag.
protected void	createSerializer(MessageType.MessageField field, String fieldName, String indent, Formatter output) Adds the Java code used to serialize the Internet address to a ByteBuffer.
Object	deserialize(ByteBuffer buffer) Returns the IPv4 or IPv6 Internet address instance de-serialized from the given buffer.
void	serialize(Object o, ByteBuffer buffer) Serializes the Internet address to the given 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 Internet address to the given buffer. Writes nothing if o is null or is not an java.net.InetAddress instance. Serializes the raw address byte array to the buffer.

Specified by:

serialize in class DataType

Parameters:

o - serialize this address instance.

buffer - write to this buffer.

Throws:

BufferOverflowException - if buffer does not contain sufficient space to hold the address bytes.

deserialize

public Object deserialize(ByteBuffer buffer)
                   throws BufferUnderflowException

Returns the IPv4 or IPv6 Internet address instance de-serialized from the given buffer. May return null.

Specified by:

deserialize in class DataType

Parameters:

buffer - read in the Internet address from this buffer.

Returns:

the Internet address object.

Throws:

BufferUnderflowException - if buffer contains an incomplete Internet address instance.

createSerializer

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

Adds the Java code used to serialize the Internet address 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 class de-serialization code storing the result according to the useBuilder flag. If true, then store the result into the message/field builder. Otherwise store the result into the named local variable.

Specified by:

createDeserializer in class DataType

Parameters:

field - message field.

fieldName - store result into this field.

indent - indent the code by this amount.

output - append the code to this formatter.

useBuilder - if true store de-serialized Internet address into the message/field builder; if false store result into named local variable.