org.rvpf.base.xml.streamer

Class StreamedMessagesWriter

Object

StreamedMessagesWriter

Direct Known Subclasses:

StreamedMessagesClient

@NotThreadSafe
public class StreamedMessagesWriter
extends Object

Streamed messages writer.

Constructor Summary

Constructors

Constructor and Description
StreamedMessagesWriter()

Method Summary

Modifier and Type	Method and Description
boolean	add(Serializable message) Adds a message.
void	close() Closes the current file.
void	flush() Flushes the output.
void	open(File file, Optional<Charset> charset) Opens an output.
void	open(OutputStream outputStream, Optional<Charset> charset) Opens an output.
void	open(Writer writer) Opens an output.
void	open(XMLElement parentElement) Opens an output.
boolean	setUp(Optional<KeyedGroups> configProperties, Optional<KeyedValues> moduleProperties) Sets up this.
void	tearDown() Tears down what has been set up.

Methods inherited from class Object

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

Constructor Detail

StreamedMessagesWriter

public StreamedMessagesWriter()

Method Detail

add

@CheckReturnValue
public boolean add(@Nonnull
                                      Serializable message)

Adds a message.

Parameters:

message - The message.

Returns:

True value on success.

close

public void close()

Closes the current file.

flush

public void flush()

Flushes the output.

open

public void open(@Nonnull
                 Writer writer)

Opens an output.

Parameters:

writer - The output writer.

open

public void open(@Nonnull
                 XMLElement parentElement)

Opens an output.

Parameters:

parentElement - The output parent element.

open

public void open(@Nonnull
                 File file,
                 @Nonnull
                 Optional<Charset> charset)
          throws FileNotFoundException

Opens an output.

Parameters:

file - The output file.

charset - An optional charset.

Throws:

FileNotFoundException - When the file cannot be created.

open

public void open(@Nonnull
                 OutputStream outputStream,
                 @Nonnull
                 Optional<Charset> charset)

Opens an output.

Parameters:

outputStream - The output stream.

charset - An optional charset.

tearDown

public void tearDown()

Tears down what has been set up.

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.