org.adroitlogic.x.base.format

Class TableMessageFormat<T extends TableMessageFormatType>

java.lang.Object

org.adroitlogic.x.base.format.TableMessageFormat<T>

All Implemented Interfaces:

XMessageFormat<T>

public abstract class TableMessageFormat<T extends TableMessageFormatType>
extends Object
implements XMessageFormat<T>

TableMessageFormat is to handle table type message payloads. This class contains all the XMessageFormat functionalities

Since:

17.07.2

Author:

Lahiru Jayathilake

Field Summary

Fields

Modifier and Type	Field and Description
protected T	data

Constructor Summary

Constructors

Constructor and Description
TableMessageFormat(T data)

Method Summary

Modifier and Type	Method and Description
T	readAsNative() Reads the native value of the payload
InputStream	readAsStream() Reads the payload as an input stream
String	readAsString(int maxLengthKbs) Reads the payload as a string.
long	size() Returns the number of rows in the table message format
void	writeTo(OutputStream outputStream) Writes the payload into the given output stream

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.adroitlogic.x.api.XMessageFormat

copyOf, markAsAttachedToaMessage, releaseResources

Field Detail

data

protected T extends TableMessageFormatType data

Constructor Detail

TableMessageFormat

public TableMessageFormat(T data)

Method Detail

readAsStream

public InputStream readAsStream()

Description copied from interface: XMessageFormat

Reads the payload as an input stream

Specified by:

readAsStream in interface XMessageFormat<T extends TableMessageFormatType>

Returns:

the input stream of the payload

readAsString

public String readAsString(int maxLengthKbs)

Description copied from interface: XMessageFormat

Reads the payload as a string. If the actual payload length exceeds the given maxLengthKbs, the output will represent a truncated payload. Otherwise the the output will represent the full payload. Depending on the type of the payload, the size of the resulting String will not be exactly the given size, but rather an approximate value.

Specified by:

readAsString in interface XMessageFormat<T extends TableMessageFormatType>

Parameters:

maxLengthKbs - the maximum length of the payload in kilo bytes to be read. Set this value as -1 to read the full payload

Returns:

the string representation of the payload approximately up to the given length

readAsNative

public T readAsNative()

Description copied from interface: XMessageFormat

Reads the native value of the payload

Specified by:

readAsNative in interface XMessageFormat<T extends TableMessageFormatType>

Returns:

the native payload value

writeTo

public void writeTo(OutputStream outputStream)
             throws IOException

Description copied from interface: XMessageFormat

Writes the payload into the given output stream

Specified by:

writeTo in interface XMessageFormat<T extends TableMessageFormatType>

Parameters:

outputStream - the output stream to which the payload has to be written

Throws:

IOException - in case of an I/O error

size

public long size()

Returns the number of rows in the table message format

Specified by:

size in interface XMessageFormat<T extends TableMessageFormatType>

Returns:

the records count