org.openlowcode.tools.messages

Class MessageStringField

java.lang.Object

org.openlowcode.tools.messages.MessageElement

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

org.openlowcode.tools.messages.MessageStringField

public class MessageStringField
extends MessageField<MessageFieldTypeString>

A field holding a string information

Author:

Open Lowcode SAS

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NULL_STRING
static char	STRING_LIMITER

Fields inherited from class org.openlowcode.tools.messages.MessageField

CONTENT_SEPARATOR, FIELD_SEPARATOR, STRUCTURE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
MessageStringField(java.lang.String fieldname, java.lang.String fieldcontent)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFieldcontent()
java.lang.String	serializepayload(java.lang.String contextstring)
static java.lang.String	serializeStringPayload(java.lang.String content, java.lang.String contextstring) Will serialize a String, managing the string delimiters and escape characters.

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

getFieldName, serialize

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

STRING_LIMITER

public static final char STRING_LIMITER

See Also:

Constant Field Values

NULL_STRING

public static final java.lang.String NULL_STRING

See Also:

Constant Field Values

Constructor Detail

MessageStringField

public MessageStringField(java.lang.String fieldname,
                          java.lang.String fieldcontent)

Parameters:

fieldname - name of the field (to be checked at parsing time)

fieldcontent - payload (java string)

Method Detail

getFieldcontent

public java.lang.String getFieldcontent()

Returns:

the payload of the String Field (may be null)

serializepayload

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

Specified by:

serializepayload in class MessageField<MessageFieldTypeString>

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

serializeStringPayload

public static java.lang.String serializeStringPayload(java.lang.String content,
                                                      java.lang.String contextstring)

Will serialize a String, managing the string delimiters and escape characters. Strings are delimited by double quote (") and double quote inside the strings are escaped as double double quoted ("")

Parameters:

content - the string to serialize

contextstring - context of calling this helper function (this is used for providing context to a potential excception

Returns: