org.rvpf.base.xml.streamer

Class StreamedMessagesReader

Object

StreamedMessagesReader

All Implemented Interfaces:

Iterable<Serializable>, Iterator<Serializable>

@NotThreadSafe
public class StreamedMessagesReader
extends Object
implements Iterator<Serializable>, Iterable<Serializable>

Streamed messages reader.

Constructor Summary

Constructors

Constructor and Description
StreamedMessagesReader()

Method Summary

Modifier and Type	Method and Description
void	close() Closes the current file.
boolean	hasNext()
Iterator<Serializable>	iterator()
Serializable	next()
void	open(File file, Optional<Charset> charset) Opens an input.
void	open(InputStream inputStream, Optional<Charset> charset) Opens an input.
void	open(Reader reader) Opens an input.
void	open(XMLElement parentElement) Opens an input.
void	remove()
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

Methods inherited from interface Iterator

forEachRemaining

Methods inherited from interface Iterable

forEach, spliterator

Constructor Detail

StreamedMessagesReader

public StreamedMessagesReader()

Method Detail

close

public void close()

Closes the current file.

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<Serializable>

iterator

public Iterator<Serializable> iterator()

Specified by:

iterator in interface Iterable<Serializable>

next

public Serializable next()

Specified by:

next in interface Iterator<Serializable>

open

public void open(@Nonnull
                 Reader reader)

Opens an input.

Parameters:

reader - The input reader.

open

public void open(@Nonnull
                 XMLElement parentElement)

Opens an input.

Parameters:

parentElement - The input parent element.

open

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

Opens an input.

Parameters:

file - The input file.

charset - A charset (may be null).

Throws:

FileNotFoundException - When the file is not found.

open

public void open(@Nonnull
                 InputStream inputStream,
                 @Nonnull
                 Optional<Charset> charset)

Opens an input.

Parameters:

inputStream - The input stream.

charset - A charset (may be null).

remove

public void remove()

Specified by:

remove in interface Iterator<Serializable>

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.