org.rvpf.base.xml.streamer

Class Streamer.Input

Object

Streamer.Input

All Implemented Interfaces:

Iterable<Serializable>, Iterator<Serializable>

Enclosing class:

Streamer

public abstract static class Streamer.Input
extends Object
implements Iterator<Serializable>, Iterable<Serializable>

Input.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Input() Constructs an input.
protected	Input(File file, Optional<Charset> charset) Constructs an input.
protected	Input(InputStream inputStream, Optional<Charset> charset) Constructs an input.
protected	Input(Reader reader) Constructs an input.

Method Summary

Modifier and Type	Method and Description
abstract void	close() Closes the input.
protected Optional<Reader>	getReader() Gets the reader.
Iterator<Serializable>	iterator()
abstract Serializable	next()
void	remove()
abstract boolean	skip() Skips the next entry.

Methods inherited from class Object

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

Methods inherited from interface Iterator

forEachRemaining, hasNext

Methods inherited from interface Iterable

forEach, spliterator

Constructor Detail

Input

protected Input()

Constructs an input.

Input

protected Input(@Nonnull
                Reader reader)

Constructs an input.

Parameters:

reader - A reader.

Input

protected Input(@Nonnull
                File file,
                @Nonnull
                Optional<Charset> charset)
         throws FileNotFoundException

Constructs an input.

Parameters:

file - An input file.

charset - An optional charset.

Throws:

FileNotFoundException - When the file is not found.

Input

protected Input(@Nonnull
                InputStream inputStream,
                @Nonnull
                Optional<Charset> charset)

Constructs an input.

Parameters:

inputStream - An input stream.

charset - An optional charset.

Method Detail

close

public abstract void close()

Closes the input.

iterator

public Iterator<Serializable> iterator()

Specified by:

iterator in interface Iterable<Serializable>

next

public abstract Serializable next()

Specified by:

next in interface Iterator<Serializable>

remove

public void remove()

Specified by:

remove in interface Iterator<Serializable>

skip

@CheckReturnValue
public abstract boolean skip()

Skips the next entry.

Returns:

True if there was an entry to skip.

getReader

@Nonnull
 @CheckReturnValue
protected Optional<Reader> getReader()

Gets the reader.

Returns:

The optional reader.