org.adroitlogic.x.base.format

Class StringFormat

java.lang.Object

org.adroitlogic.x.base.format.StringFormat

All Implemented Interfaces:

XMessageFormat<String>

public class StringFormat
extends Object
implements XMessageFormat<String>

A message format implementation that holds the payload as a string

Since:

17.01

Author:

Ruwan Linton

Constructor Summary

Constructors

Constructor and Description
StringFormat(String content)

Method Summary

Modifier and Type	Method and Description
XMessageFormat<String>	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
String	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() 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

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

markAsAttachedToaMessage, releaseResources

Constructor Detail

StringFormat

public StringFormat(String content)

Method Detail

readAsStream

public InputStream readAsStream()

Description copied from interface: XMessageFormat

Reads the payload as an input stream

Specified by:

readAsStream in interface XMessageFormat<String>

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<String>

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 String readAsNative()

Description copied from interface: XMessageFormat

Reads the native value of the payload

Specified by:

readAsNative in interface XMessageFormat<String>

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<String>

Parameters:

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

Throws:

IOException - in case of an I/O error

copyOf

public XMessageFormat<String> copyOf()

Description copied from interface: XMessageFormat

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

Specified by:

copyOf in interface XMessageFormat<String>

Returns:

a cloned message format possibly with a cloned payload

size

public long size()

Description copied from interface: XMessageFormat

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

Specified by:

size in interface XMessageFormat<String>

Returns:

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