DataType (eBus Core 5.2.1 API)

java.lang.Object
- net.sf.eBus.messages.type.DataType

All Implemented Interfaces:

Comparable<DataType>

Direct Known Subclasses:

ArrayType, BigDecimalType, BigIntegerType, BooleanType, ByteType, CharType, ClassType, DateType, DoubleType, DurationType, EnumType, FieldListType, FileType, FloatType, InetAddressType, InetSocketAddressType, InstantType, IntType, LocalDateTimeType, LocalDateType, LocalTimeType, LongType, MessageKeyType, MessageListType, MessageType, MonthDayType, OffsetDateTimeType, OffsetTimeType, PeriodType, ShortType, StringType, UriType, YearMonthType, YearType, ZonedDateTimeType, ZoneIdType, ZoneOffsetType
```
public abstract class DataType
extends Object
implements Comparable<DataType>
```
All message fields have an associated DataType subclass which is responsible for serializing and deserializing field values. Both binary and text serialization is supported. This class maintains a Java class-to-DataType instance map. Thus for each EField class, there is only one data type instance used for serialization. The data type instances are created only as needed and only once.

Author:

Charles Rapp

Field Summary

Fields
Modifier and Type	Field and Description
`protected static InetAddressType`	`ADDRESS_TYPE` The Internet address type is used to serialize and de-serialize the address portion of the socket address.
`static String`	`ARRAY_SUFFIX` A Type name ending in "[]" is an array.
`static Charset`	`CHARSET` eBus uses `StandardCharsets.UTF_8` to serialize and de-serialize strings.
`protected static ClassType`	`CLASS_TYPE` Used to serialize/de-serialize a Java class.
`protected static String`	`EMPTY_STRING` The default return value for text serialization is an empty string ("").
`protected static int`	`FIELD_MASK_SIZE` The field mask is a 4-byte, signed integer.
`protected static String`	`INDENT` Use two blanks as generated retval indent.
`protected static String`	`INDENT1` A four blank indent used for fields.
`protected static MessageKeyType`	`KEY_TYPE` Used to serialize/de-serialize an eBus message key.
`static int`	`MAX_ARRAY_SIZE` An array or collection data type may contain at most 1,000 elements.
`static int`	`MAX_FIELDS` A message object may have at most 31 fields.
`static int`	`MAX_FILE_NAME_LENGTH` The maximum file name length is 1,024 characters.
`static int`	`MAX_STRING_LENGTH` Strings may be at most 1,024 characters.
`protected boolean`	`mBuiltinFlag` This flag is `true` if the data type is considered a built-in type.
`protected Class<?>`	`mClass` The Java class represented by this data type.
`protected Object`	`mDefaultValue` If a built-in type value is not specified, then set it to this default value.
`protected int`	`mSize` Number of bytes needed to represent this data type.
`protected static Map<String,Class<?>>`	`sClasses` Caches the Java class instance associated with a given fully-qualified class name.
`protected static List<Class<? extends EMessageObject>>`	`sCompiledClasses` Tracks which `EMessageObject` classes are compiled.
`protected static StringType`	`STRING_TYPE` Used by subclass for `String` serialization/de-serialization.
`static int`	`VARIABLE_SIZE` When a data type's size is variable then set the size to `Integer.MAX_VALUE`.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DataType(Class<?> jClass, boolean builtinFlag, int size, Object defaultValue)` Set this data type Java class type.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(DataType dataType)` Returns an integer value < zero, zero or > 0 if this data type is <, equals or > `findType`.
`protected abstract void`	`createDeserializer(MessageType.MessageField field, String fieldName, String indent, Formatter output, boolean useBuilder)` Adds the Java retval used to de-serialize the named field from a `ByteBuffer`.
`protected abstract void`	`createSerializer(MessageType.MessageField field, String fieldName, String indent, Formatter output)` Adds the Java retval used to serialize the named field to a `ByteBuffer`.
`Class<?>`	`dataClass()` Returns the associated Java class.
`String`	`dataClassName()` Returns the Java class name.
`Object`	`defaultValue()` Returns the default value for this type.
`abstract Object`	`deserialize(ByteBuffer buffer)` Returns the deserialized object in `buffer`.
`boolean`	`equals(Object o)` Returns `true` if `o` is not `null`, is an instance of `DataType` and has the same Java class.
`static List<MultiKey2<String,DataType>>`	`fields(Class<? extends EMessageObject> mc)` Returns the specified message class or field class field name, data type pairs.
`protected static Charset`	`findCharset(String name)` Returns the character set with the given name.
`static DataType`	`findType(Class<?> jClass)` Returns the data type object associated with the class.
`int`	`hashCode()` Returns the data type's hash retval based on the class type.
`boolean`	`isArray()` Returns `true` if this data type is an array and `false` otherwise.
`boolean`	`isBuiltin()` Returns `true` if this data type is considered an eBus built-in type and `false` otherwise.
`boolean`	`isEnum()` Returns `true` if this is an enum data type and `false` otherwise.
`boolean`	`isInstance(Object o)` Returns `true` if `o` is of the proper type and `false` otherwise.
`boolean`	`isLocalOnly()` Returns `true` if this message type is local-only and `false` if this message type may be transmitted to remote eBus applications.
`boolean`	`isMessage()` Returns `true` if this message type is for an `EMessage` and `false` if for an `EField`.
`boolean`	`isPrimitive()` Returns `true` if this data type is for a Java primitive type and `false` otherwise.
`static List<Class<? extends EReplyMessage>>`	`replyClasses(String[] args)` Returns the reply classes associated with a request message class via the `EReplyInfo` annotation.
`abstract void`	`serialize(Object o, ByteBuffer buffer)` Serializes `o` to the given `buffer`.
`int`	`size()` Returns the data type size in bytes.
`String`	`toString()` Returns the data type's Java class name.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAX_ARRAY_SIZE
```
public static final int MAX_ARRAY_SIZE
```
    An array or collection data type may contain at most 1,000 elements.
    
    See Also:
    
    Constant Field Values
  - MAX_STRING_LENGTH
```
public static final int MAX_STRING_LENGTH
```
    Strings may be at most 1,024 characters.
    
    See Also:
    
    Constant Field Values
  - MAX_FILE_NAME_LENGTH
```
public static final int MAX_FILE_NAME_LENGTH
```
    The maximum file name length is 1,024 characters.
    
    See Also:
    
    Constant Field Values
  - MAX_FIELDS
```
public static final int MAX_FIELDS
```
    A message object may have at most 31 fields. This is because there are 31 usable bits in a 4-byte, signed integer.
    
    See Also:
    
    Constant Field Values
  - CHARSET
```
public static final Charset CHARSET
```
    eBus uses StandardCharsets.UTF_8 to serialize and de-serialize strings.
  - ARRAY_SUFFIX
```
public static final String ARRAY_SUFFIX
```
    A Type name ending in "[]" is an array.
    
    See Also:
    
    Constant Field Values
  - VARIABLE_SIZE
```
public static final int VARIABLE_SIZE
```
    When a data type's size is variable then set the size to Integer.MAX_VALUE.
    
    See Also:
    
    Constant Field Values
  - FIELD_MASK_SIZE
```
protected static final int FIELD_MASK_SIZE
```
    The field mask is a 4-byte, signed integer.
    
    See Also:
    
    Constant Field Values
  - EMPTY_STRING
```
protected static final String EMPTY_STRING
```
    The default return value for text serialization is an empty string ("").
    
    See Also:
    
    Constant Field Values
  - INDENT
```
protected static final String INDENT
```
    Use two blanks as generated retval indent.
    
    See Also:
    
    Constant Field Values
  - INDENT1
```
protected static final String INDENT1
```
    A four blank indent used for fields.
    
    See Also:
    
    Constant Field Values
  - STRING_TYPE
```
protected static final StringType STRING_TYPE
```
    Used by subclass for String serialization/de-serialization.
  - ADDRESS_TYPE
```
protected static final InetAddressType ADDRESS_TYPE
```
    The Internet address type is used to serialize and de-serialize the address portion of the socket address.
  - CLASS_TYPE
```
protected static final ClassType CLASS_TYPE
```
    Used to serialize/de-serialize a Java class.
  - KEY_TYPE
```
protected static final MessageKeyType KEY_TYPE
```
    Used to serialize/de-serialize an eBus message key.
  - sClasses
```
protected static final Map<String,Class<?>> sClasses
```
    Caches the Java class instance associated with a given fully-qualified class name.
  - sCompiledClasses
```
protected static final List<Class<? extends EMessageObject>> sCompiledClasses
```
    Tracks which EMessageObject classes are compiled.
  - mClass
```
protected transient Class<?> mClass
```
    The Java class represented by this data type.
  - mBuiltinFlag
```
protected final boolean mBuiltinFlag
```
    This flag is true if the data type is considered a built-in type.
  - mSize
```
protected final int mSize
```
    Number of bytes needed to represent this data type.
  - mDefaultValue
```
protected final Object mDefaultValue
```
    If a built-in type value is not specified, then set it to this default value. Will be null for all other types.
- Constructor Detail
  - DataType
```
protected DataType(Class<?> jClass,
                   boolean builtinFlag,
                   int size,
                   Object defaultValue)
```
    Set this data type Java class type.
    
    Parameters:
    
    jClass - the Java associated Java class.
    
    builtinFlag - true if this data type is a built-in type.
    
    size - data type size in bytes.
    
    defaultValue - the default value for this type.
- Method Detail
  - serialize
```
public abstract void serialize(Object o,
                               ByteBuffer buffer)
                        throws BufferOverflowException
```
    Serializes o to the given buffer.
    
    Parameters:
    
    o - serialize this object.
    
    buffer - serialize o to this buffer.
    
    Throws:
    
    BufferOverflowException - if serializing o overruns buffer's available capacity.
  - deserialize
```
public abstract Object deserialize(ByteBuffer buffer)
                            throws BufferUnderflowException,
                                   ValidationException
```
    Returns the deserialized object in buffer.
    
    Parameters:
    
    buffer - Deserialize the object from this ByteBuffer.
    
    Returns:
    
    the deserialized object.
    
    Throws:
    
    BufferUnderflowException - if buffer contains fewer bytes than needed to completely deserialize the object.
    
    ValidationException - if buffer contains an invalid eBus message.
  - createSerializer
```
protected abstract void createSerializer(MessageType.MessageField field,
                                         String fieldName,
                                         String indent,
                                         Formatter output)
```
    Adds the Java retval used to serialize the named field to a ByteBuffer.
    
    Parameters:
    
    field - message field.
    
    fieldName - the message field name.
    
    indent - indent the retval by this amount.
    
    output - write the retval to this formatter.
  - createDeserializer
```
protected abstract void createDeserializer(MessageType.MessageField field,
                                           String fieldName,
                                           String indent,
                                           Formatter output,
                                           boolean useBuilder)
```
    Adds the Java retval used to de-serialize the named field from a ByteBuffer. Store the result into a message/field builder if useBuilder is true and into a local field otherwise.
    
    Parameters:
    
    field - message field.
    
    fieldName - fully-qualified message field name.
    
    indent - indent the retval by this amount.
    
    output - write the retval to this formatter.
    
    useBuilder - if true then fieldName is a builder method name; otherwise a local variable.
  - compareTo
```
public int compareTo(DataType dataType)
```
    Returns an integer value < zero, zero or > 0 if this data type is <, equals or > findType. The comparison is based on the class name.
    
    Specified by:
    
    compareTo in interface Comparable<DataType>
    
    Parameters:
    
    dataType - compare to this data type.
    
    Returns:
    
    an integer value < zero, zero or > 0 if this data type is <, equals or > findType.
  - equals
```
public boolean equals(Object o)
```
    Returns true if o is not null, is an instance of DataType and has the same Java class. Otherwise returns false.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - compare against this object.
    
    Returns:
    
    true if o is not null, is an instance of DataType and has the same Java class. Otherwise returns false.
  - hashCode
```
public int hashCode()
```
    Returns the data type's hash retval based on the class type.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    the data type's hash retval based on the class type.
  - toString
```
public String toString()
```
    Returns the data type's Java class name.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the data type's Java class name.
  - isInstance
```
public boolean isInstance(Object o)
```
    Returns true if o is of the proper type and false otherwise.
    
    Parameters:
    
    o - check this object's type.
    
    Returns:
    
    true if o is of the proper type and false otherwise.
  - dataClass
```
public final Class<?> dataClass()
```
    Returns the associated Java class.
    
    Returns:
    
    the associated Java class.
  - dataClassName
```
public String dataClassName()
```
    Returns the Java class name.
    
    Returns:
    
    Java class name.
  - isArray
```
public final boolean isArray()
```
    Returns true if this data type is an array and false otherwise.
    
    Returns:
    
    true if the data type is an array.
  - isBuiltin
```
public final boolean isBuiltin()
```
    Returns true if this data type is considered an eBus built-in type and false otherwise.
    
    Returns:
    
    true if this is an eBus built-in type.
  - isPrimitive
```
public final boolean isPrimitive()
```
    Returns true if this data type is for a Java primitive type and false otherwise.
    
    Returns:
    
    true if this is a Java primitive type.
  - isEnum
```
public final boolean isEnum()
```
    Returns true if this is an enum data type and false otherwise.
    
    Returns:
    
    true if this is an enum data type.
  - isMessage
```
public final boolean isMessage()
```
    Returns true if this message type is for an EMessage and false if for an EField.
    
    Returns:
    
    true if the underlying type is an EMessage.
  - isLocalOnly
```
public boolean isLocalOnly()
```
    Returns true if this message type is local-only and false if this message type may be transmitted to remote eBus applications.
    
    Returns:
    
    true if this is a local-only message object.
  - size
```
public final int size()
```
    Returns the data type size in bytes. Returns VARIABLE_SIZE if the type size is variable.
    
    Returns:
    
    data type byte size.
  - defaultValue
```
public final Object defaultValue()
```
    Returns the default value for this type. May return null.
    
    Returns:
    
    type default value.
  - findType
```
public static DataType findType(Class<?> jClass)
                         throws IllegalArgumentException,
                                InvalidMessageException
```
    Returns the data type object associated with the class. If no such object is cached, then attempts to create a DataType for jClass. Throws either an IllegalArgumentException or InvalidMessageException if this cannot be done.
    
    Parameters:
    
    jClass - A Java class instance.
    
    Returns:
    
    the data type object associated with the class.
    
    Throws:
    
    IllegalArgumentException - if jClass is an unsupported eBus message type.
    
    InvalidMessageException - if jClass is an EMessageObject with an invalid message layout.
  - fields
```
public static List<MultiKey2<String,DataType>> fields(Class<? extends EMessageObject> mc)
                                               throws IllegalArgumentException,
                                                      InvalidMessageException
```
    Returns the specified message class or field class field name, data type pairs. The returned field order matches defines field serialization order.
    
    Parameters:
    
    mc - find the fields for this EMessage or EField class.
    
    Returns:
    
    mc field name, data type pairs.
    
    Throws:
    
    IllegalArgumentException - if mc is null.
    
    InvalidMessageException - if mc is an invalid eBus message.
  - replyClasses
```
public static List<Class<? extends EReplyMessage>> replyClasses(String[] args)
```
    Returns the reply classes associated with a request message class via the EReplyInfo annotation. This method is called by compiled request message class to initialize the private static final Class[] REPLY_CLASSES field.
    
    Parameters:
    
    args - single element array containing the message class name.
    
    Returns:
    
    the requests associated reply message classes. Returns an empty list for any error.
  - findCharset
```
protected static Charset findCharset(String name)
```
    Returns the character set with the given name. If name is not valid, then returns CHARSET.
    
    Parameters:
    
    name - character set name.
    
    Returns:
    
    named character set.

Class DataType

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_ARRAY_SIZE

MAX_STRING_LENGTH

MAX_FILE_NAME_LENGTH

MAX_FIELDS

CHARSET

ARRAY_SUFFIX

VARIABLE_SIZE

FIELD_MASK_SIZE

EMPTY_STRING

INDENT

INDENT1

STRING_TYPE

ADDRESS_TYPE

CLASS_TYPE

KEY_TYPE

sClasses

sCompiledClasses

mClass

mBuiltinFlag

mSize

mDefaultValue

Constructor Detail

DataType

Method Detail

serialize

deserialize

createSerializer

createDeserializer

compareTo

equals

hashCode

toString

isInstance

dataClass

dataClassName

isArray

isBuiltin

isPrimitive

isEnum

isMessage

isLocalOnly

size

defaultValue

findType

fields

replyClasses

findCharset