org.openlowcode.tools.messages

Class MessageField<E extends MessageFieldType>

java.lang.Object

org.openlowcode.tools.messages.MessageElement

org.openlowcode.tools.messages.MessageField<E>

Direct Known Subclasses:

MessageBinaryField, MessageBooleanField, MessageDateField, MessageDecimalField, MessageIntegerField, MessageStringField

public abstract class MessageField<E extends MessageFieldType>
extends MessageElement

Gathers all fields that are transported as text in a CML Message.

Author:

Open Lowcode SAS

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CONTENT_SEPARATOR
protected static java.lang.String	FIELD_SEPARATOR
protected static java.lang.String	STRUCTURE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
MessageField(java.lang.String fieldname) Creates a new MessageField

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFieldName()
java.lang.String	serialize(java.lang.String padding, boolean firstattribute) A field is serialized with ':' (column) if first field, ',' (comma) if second or later field the field name '=' (equal) payload (detailed in each subclass)
abstract java.lang.String	serializepayload(java.lang.String contextstring)

Methods inherited from class org.openlowcode.tools.messages.MessageElement

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CONTENT_SEPARATOR

protected static final java.lang.String CONTENT_SEPARATOR

See Also:

Constant Field Values

FIELD_SEPARATOR

protected static final java.lang.String FIELD_SEPARATOR

See Also:

Constant Field Values

STRUCTURE_SEPARATOR

protected static final java.lang.String STRUCTURE_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

MessageField

public MessageField(java.lang.String fieldname)

Creates a new MessageField

Parameters:

fieldname - the field name, assumed to be checked by the receiver for consistency.

Method Detail

getFieldName

public java.lang.String getFieldName()

serialize

public java.lang.String serialize(java.lang.String padding,
                                  boolean firstattribute)

A field is serialized with

• ':' (column) if first field, ',' (comma) if second or later field
• the field name
• '=' (equal)
• payload (detailed in each subclass)

Specified by:

serialize in class MessageElement

firstattribute - indicates if this element if the first attribute inside the structure If not, it is expected that the serialization print a separator (comma)

Returns:

serialization of the field

serializepayload

public abstract java.lang.String serializepayload(java.lang.String contextstring)

Parameters:

contextstring - a string that will be included in the exception in case of error

Returns:

a value in string, potentially multi-line, of the field payload