net.sf.eBus.messages.type

Class MessageType.MessageField

java.lang.Object

net.sf.eBus.messages.type.MessageType.MessageField

Enclosing class:

MessageType

public static final class MessageType.MessageField
extends Object

Stores a field index, field name, class field, eBus data type. Fields are indexed incrementally from zero to the number of message fields - 1. The index is used to maintain field ordering.

This class is immutable.

Author:

Charles Rapp

Constructor Summary

Constructors

Constructor and Description
MessageField(int index, String name, MethodHandle field, DataType eType, String charset, boolean optFlag) Stores the layout field attributes.

Method Summary

Modifier and Type	Method and Description
String	charset() Returns the associated character set used to serialize a text field if this field is of StringType.
DataType	dataType() Returns the eBus data type.
boolean	equals(Object o) Returns true if o is a non-null MessageType.Field with the same index as this field.
MethodHandle	field() Returns the Java class field.
int	hashCode() Returns the field index as the hash code.
int	index() Returns the field index.
boolean	isArray() Returns true if this is an array field and false otherwise.
boolean	isOptional() Returns true if this field is option and, therefore, may be set to null.
Class<?>	javaType() Returns the Java class associated with this field.
String	name() Returns the field name.
MethodHandle	setter() Returns the message builder class setter method for this field.
String	toString() Returns the string representation of this message field.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MessageField

public MessageField(int index,
                    String name,
                    MethodHandle field,
                    DataType eType,
                    String charset,
                    boolean optFlag)

Stores the layout field attributes.

Parameters:

index - field index (≥ zero)

name - the field name.

field - the message field.

eType - eBus field data type.

charset - name of java.nio.charset.Charset class.

optFlag - true if field may be set to null.

Method Detail

equals

public boolean equals(Object o)

Returns true if o is a non-null MessageType.Field with the same index as this field.

Overrides:

equals in class Object

Parameters:

o - comparison object.

Returns:

true if o equals this layout field.

hashCode

public int hashCode()

Returns the field index as the hash code.

Overrides:

hashCode in class Object

Returns:

the field index.

toString

public String toString()

Returns the string representation of this message field.

Overrides:

toString in class Object

Returns:

the string representation of this message field.

index

public int index()

Returns the field index.

Returns:

the field index.

name

public String name()

Returns the field name.

Returns:

the field name.

field

public MethodHandle field()

Returns the Java class field.

Returns:

the Java class field.

javaType

public Class<?> javaType()

Returns the Java class associated with this field.

Returns:

the field Java class.

dataType

public DataType dataType()

Returns the eBus data type.

Returns:

the eBus data type.

isArray

public boolean isArray()

Returns true if this is an array field and false otherwise.

Returns:

true if this is an array field and false otherwise.

charset

public String charset()

Returns the associated character set used to serialize a text field if this field is of StringType. Otherwise returns null.

Returns:

character set if field is string type and null otherwise.

isOptional

public boolean isOptional()

Returns true if this field is option and, therefore, may be set to null.

Returns:

true if field is optional.

setter

public MethodHandle setter()

Returns the message builder class setter method for this field.

Returns:

builder setter method.