Interface DataConverter

public interface DataConverter

Container class that allows retrieving various representations of its contents.

If the underlying data is binary, and a character representation is required, then the container implementation should have the means to determine the character set of the underlying data. The character set is not passed in to any of the interface methods.

Method Summary

Modifier and Type	Method	Description
byte @Nullable []	asByteArray()	Returns a byte[] representing the data in this container, or NULL if isNull().
@Nullable InputSource	asInputSource()	Return the underlying data as an XML InputSource.
InputStream	asInputStream()	Return data as an InputStream.
InputStream	asInputStream(String encodingCharset)	Return data as an InputStream, encoded in the specified encodingCharset.
@Nullable Object	asRawObject()	Returns the raw object inside this container, or NULL if isNull().
Reader	asReader()	Return data as a Reader.
@Nullable Serializable	asSerializable()	Returns a Serializable representation of the data, or NULL if isNull().
@Nullable Source	asSource()	Return the underlying data as an XML InputSource.
@Nullable String	asString()	Returns a String representing the data in this container, or NULL if isNull().
boolean	isBinary()	Check if the underlying data is binary, or natively character-based.
boolean	isEmpty()	Check if the data in the container is empty, such as a String of length 0.
default boolean	isNull()	Check if the container contains NULL data or not.
boolean	prefersStreaming()	Check if the data prefers to be represented in a Streaming format (InputStream or Reader.
long	size()	Size of (the binary representation of) the data, if possible to determine.

Method Details

isBinary

boolean isBinary()

Check if the underlying data is binary, or natively character-based. Not related to whether a character set can be derived for the data.

isEmpty

boolean isEmpty()

Check if the data in the container is empty, such as a String of length 0. This is not the same as NULL data, but NULL is always empty.

isNull

default boolean isNull()

Check if the container contains NULL data or not.

prefersStreaming

boolean prefersStreaming()

Check if the data prefers to be represented in a Streaming format (InputStream or Reader. Generally, this implies the data is not readily available in-memory.

size

long size()

Size of (the binary representation of) the data, if possible to determine. When isEmpty() or isNull(), this method returns 0. When the size of the data cannot be determined, will return Message.MESSAGE_SIZE_UNKNOWN.

asRawObject

@Nullable Object asRawObject()

Returns the raw object inside this container, or NULL if isNull().

asSerializable

@Nullable Serializable asSerializable()
                               throws IOException

Returns a Serializable representation of the data, or NULL if isNull(). This may be the same instance as the original data, if it already implements Serializable natively.

Throws:

IOException

asString

@Nullable String asString()
                   throws IOException

Returns a String representing the data in this container, or NULL if isNull().

Throws:

IOException

asByteArray

byte @Nullable [] asByteArray()
                       throws IOException

Returns a byte[] representing the data in this container, or NULL if isNull().

Throws:

IOException

asReader

Reader asReader()
         throws IOException

Return data as a Reader. The Reader is guaranteed to support Reader.mark(int) and Reader.reset().

Returns:

A Reader backed by the represented data. The Reader might not have any data. Will never return NULL.

Throws:

IOException - When any error occurs.

asInputStream

InputStream asInputStream()
                   throws IOException

Return data as an InputStream. The InputStream is guaranteed to support InputStream.mark(int) and InputStream.reset(). If the underlying data is character-based, the encoding of the stream is the StreamUtil.DEFAULT_INPUT_STREAM_ENCODING.

Returns:

An InputStream backed by the represented data. The InputStream might not have any data. Will never return NULL.

Throws:

IOException - When any error occurs.

asInputStream

InputStream asInputStream(String encodingCharset)
                   throws IOException

Return data as an InputStream, encoded in the specified encodingCharset. The InputStream is guaranteed to support InputStream.mark(int) and InputStream.reset().

Parameters:

encodingCharset - The charset into which to encode the data on the InputStream.

Returns:

An InputStream backed by the represented data, (re-)encoded in the specified encodingCharset. The InputStream might not have any data. Will never return NULL.

Throws:

IOException - When there was an error.

asInputSource

@Nullable InputSource asInputSource()
                             throws IOException

Return the underlying data as an XML InputSource.

Throws:

IOException

asSource

@Nullable Source asSource()
                   throws IOException,
SAXException

Return the underlying data as an XML InputSource.

Throws:

IOException

SAXException