org.rvpf.base.xml.streamer

Class Streamer.Output

Object

Streamer.Output

Enclosing class:

Streamer

public abstract static class Streamer.Output
extends Object

Output.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Output() Constructs an output.
protected	Output(File file, Optional<Charset> charset) Constructs an output.
protected	Output(OutputStream outputStream, Optional<Charset> charset) Constructs an output.
protected	Output(Writer writer) Constructs an output.

Method Summary

Modifier and Type	Method and Description
abstract boolean	add(Serializable serializable) Adds a serializable.
abstract void	close() Closes the output.
abstract void	flush() Flushes the output.
protected Optional<Writer>	getWriter() Gets the writer.
protected boolean	validate(Serializable serializable) Validates a serializable.

Methods inherited from class Object

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

Constructor Detail

Output

protected Output()

Constructs an output.

Output

protected Output(@Nonnull
                 Writer writer)

Constructs an output.

Parameters:

writer - A writer.

Output

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

Constructs an output.

Parameters:

file - An output file.

charset - An optional charset.

Throws:

FileNotFoundException - When the file is not found.

Output

protected Output(@Nonnull
                 OutputStream outputStream,
                 @Nonnull
                 Optional<Charset> charset)

Constructs an output.

Parameters:

outputStream - An output stream.

charset - An optional charset.

Method Detail

add

@CheckReturnValue
public abstract boolean add(Serializable serializable)

Adds a serializable.

Parameters:

serializable - The serializable.

Returns:

False when a Streamer.Validated serializable is invalid.

close

public abstract void close()

Closes the output.

flush

public abstract void flush()

Flushes the output.

getWriter

@Nonnull
 @CheckReturnValue
protected Optional<Writer> getWriter()

Gets the writer.

Returns:

The optional writer.

validate

@CheckReturnValue
protected boolean validate(Serializable serializable)

Validates a serializable.

Parameters:

serializable - The serializable.

Returns:

True when valid.