org.rvpf.base.xml.streamer

Class StreamedMessagesConverter

Object

StreamedMessagesConverter

@NotThreadSafe
public final class StreamedMessagesConverter
extends Object

Streamed messages converter.

Constructor Summary

Constructors

Constructor and Description
StreamedMessagesConverter()

Method Summary

Modifier and Type	Method and Description
Optional<Serializable>	fromXMLChars(char[] xml) Converts from XML characters.
Optional<Serializable>	fromXMLString(String xml) Converts from a XML string.
boolean	setUp(Optional<KeyedGroups> configProperties, Optional<KeyedValues> moduleProperties) Sets up this.
void	tearDown() Tears down what has been set up.
char[]	toXMLChars(Serializable message) Converts to XML characters.
String	toXMLString(Serializable message) Converts to a XML string.

Methods inherited from class Object

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

Constructor Detail

StreamedMessagesConverter

public StreamedMessagesConverter()

Method Detail

fromXMLChars

@CheckReturnValue
public Optional<Serializable> fromXMLChars(@Nonnull
                                                              char[] xml)

Converts from XML characters.

Parameters:

xml - The XML characters.

Returns:

The optional message.

fromXMLString

@Nonnull
 @CheckReturnValue
public Optional<Serializable> fromXMLString(@Nonnull
                                                                          String xml)

Converts from a XML string.

Parameters:

xml - The XML string.

Returns:

The optional message.

tearDown

public void tearDown()

Tears down what has been set up.

toXMLChars

@Nullable
 @CheckReturnValue
public char[] toXMLChars(@Nonnull
                                                        Serializable message)

Converts to XML characters.

Parameters:

message - The message.

Returns:

The XML characters (null on failure).

toXMLString

@Nullable
 @CheckReturnValue
public String toXMLString(@Nonnull
                                                         Serializable message)

Converts to a XML string.

Parameters:

message - The message.

Returns:

The XML string (null on failure).

setUp

@CheckReturnValue
public boolean setUp(@Nonnull
                                        Optional<KeyedGroups> configProperties,
                                        @Nonnull
                                        Optional<KeyedValues> moduleProperties)

Sets up this.

Parameters:

configProperties - The optional configuration properties.

moduleProperties - The optional module properties.

Returns:

True on success.