org.adroitlogic.x.api

Interface XMessageFormat<T>

All Known Implementing Classes:

ByteArrayFormat, EmptyFormat, FileFormat, MapFormat, ObjectFormat, ResourceAwareMessageFormat, StringFormat, TableMessageFormat

public interface XMessageFormat<T>

This is the base for all payload types. Implementations of this interface is generally supposed to be immutable. A message contains a message format which is represented by an implementation of this interface. While it is possible to access the raw implementation of this class at runtime it is recommended to create payloads using the PayloadFactory specially within any processing elements

Since:

17.01

Author:

Ruwan Linton

See Also:

XMessage, PayloadFactory

Method Summary

Modifier and Type	Method and Description
XMessageFormat<T>	copyOf() Clones the message format possibly cloning the payload within this format, if an implementation doesn't support cloning it is expected that particular implementation to throw an UnsupportedOperationException
default void	markAsAttachedToaMessage() Used to mark this XMessageFormat has been set to a XMessage instance's payload so it would be released with the said XMessage's end of life.
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.
default void	releaseResources() Used to clear the underlying resources when such cleaning needed.
long	size() Gives the size of the underneath payload type, which is specific to the implementation of the message format.
void	writeTo(OutputStream outputStream) Writes the payload into the given output stream

Method Detail

readAsStream

InputStream readAsStream()

Reads the payload as an input stream

Returns:

the input stream of the payload

readAsString

String readAsString(int maxLengthKbs)

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.

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

T readAsNative()

Reads the native value of the payload

Returns:

the native payload value

writeTo

void writeTo(OutputStream outputStream)
      throws IOException

Writes the payload into the given output stream

Parameters:

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

Throws:

IOException - in case of an I/O error

copyOf

XMessageFormat<T> copyOf()

Clones the message format possibly cloning the payload within this format, if an implementation doesn't support cloning it is expected that particular implementation to throw an UnsupportedOperationException

Returns:

a cloned message format possibly with a cloned payload

size

long size()

Gives the size of the underneath payload type, which is specific to the implementation of the message format. It is not guaranteed that this will always return the byte size of the payload, for example in case of a collection backed payload it could return the number of elements in the collection instead of the total bytes allocated by the payload structure

Returns:

the size of the payload, which is specific to the implementation

releaseResources

default void releaseResources()

Used to clear the underlying resources when such cleaning needed. It does not mean every time this method get invoked there is a resource cleaning involved. It depends on the implementation.

markAsAttachedToaMessage

default void markAsAttachedToaMessage()

Used to mark this XMessageFormat has been set to a XMessage instance's payload so it would be released with the said XMessage's end of life. Default implementation does nothing as all the implementations of XMessageFormat which require explicit resource cleaning should extend from org.adroitlogic.x.base.format.ResourceAwareMessageFormat class