org.rvpf.base.xml.streamer

Class Streamer

Object

Streamer

Direct Known Subclasses:

XStreamStreamer

@NotThreadSafe
public abstract class Streamer
extends Object

Streamer.

Facade to (de)serialize values.

The current implementation uses XStream as back end.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Streamer.Input Input.
static class	Streamer.Output Output.
static interface	Streamer.Validated Validated.

Constructor Summary

Constructors

Constructor and Description
Streamer()

Method Summary

Modifier and Type	Method and Description
Serializable	fromXML(XMLElement xmlElement) Returns the serializable represented by an XML element.
abstract Streamer.Input	newInput(File file, Optional<Charset> charset) Returns a new input.
abstract Streamer.Input	newInput(InputStream inputStream, Optional<Charset> charset) Returns a new input.
abstract Streamer.Input	newInput(Reader reader) Returns a new input.
Streamer.Input	newInput(XMLDocument xmlDocument) Returns a new input.
abstract Streamer.Input	newInput(XMLElement parentElement) Returns a new input.
static Streamer	newInstance() Returns a new instance.
abstract Streamer.Output	newOutput(File file, Optional<Charset> charset) Returns a new output.
abstract Streamer.Output	newOutput(OutputStream outputStream, Optional<Charset> charset) Returns a new output.
abstract Streamer.Output	newOutput(Writer writer) Returns a new output.
abstract Streamer.Output	newOutput(XMLElement parentElement) Returns a new output.
abstract boolean	setUp(Optional<KeyedGroups> configProperties, Optional<KeyedValues> moduleProperties) Sets up this.
abstract void	tearDown() Tears down what has been set up.
XMLElement	toXML(Serializable serializable) Returns a serializable as an XML element.

Methods inherited from class Object

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

Constructor Detail

Streamer

public Streamer()

Method Detail

newInstance

@Nonnull
 @CheckReturnValue
public static Streamer newInstance()

Returns a new instance.

Returns:

The new instance.

fromXML

@Nullable
 @CheckReturnValue
public Serializable fromXML(@Nonnull
                                                           XMLElement xmlElement)

Returns the serializable represented by an XML element.

Parameters:

xmlElement - The XML element.

Returns:

The serializable (may have a null value).

newInput

@Nonnull
 @CheckReturnValue
public abstract Streamer.Input newInput(@Nonnull
                                                                      Reader reader)

Returns a new input.

Parameters:

reader - A reader.

Returns:

The new input.

newInput

@Nonnull
 @CheckReturnValue
public Streamer.Input newInput(@Nonnull
                                                             XMLDocument xmlDocument)

Returns a new input.

Parameters:

xmlDocument - An XML document.

Returns:

The new input.

newInput

@Nonnull
 @CheckReturnValue
public abstract Streamer.Input newInput(@Nonnull
                                                                      XMLElement parentElement)

Returns a new input.

Parameters:

parentElement - A parent element.

Returns:

The new input.

newInput

@Nonnull
 @CheckReturnValue
public abstract Streamer.Input newInput(@Nonnull
                                                                      File file,
                                                                      @Nonnull
                                                                      Optional<Charset> charset)
                                                               throws FileNotFoundException

Returns a new input.

Parameters:

file - An input file.

charset - An optional charset.

Returns:

The new input.

Throws:

FileNotFoundException - When the file is not found.

newInput

@Nonnull
 @CheckReturnValue
public abstract Streamer.Input newInput(@Nonnull
                                                                      InputStream inputStream,
                                                                      @Nonnull
                                                                      Optional<Charset> charset)

Returns a new input.

Parameters:

inputStream - An input stream.

charset - An optional charset.

Returns:

The new input.

newOutput

@Nonnull
 @CheckReturnValue
public abstract Streamer.Output newOutput(@Nonnull
                                                                        Writer writer)

Returns a new output.

Parameters:

writer - A writer.

Returns:

The new output.

newOutput

@Nonnull
 @CheckReturnValue
public abstract Streamer.Output newOutput(@Nonnull
                                                                        XMLElement parentElement)

Returns a new output.

Parameters:

parentElement - A parent element.

Returns:

The new output.

newOutput

@Nonnull
 @CheckReturnValue
public abstract Streamer.Output newOutput(@Nonnull
                                                                        File file,
                                                                        @Nonnull
                                                                        Optional<Charset> charset)
                                                                 throws FileNotFoundException

Returns a new output.

Parameters:

file - An output file.

charset - An optional charset.

Returns:

The new output.

Throws:

FileNotFoundException - When the file is not found.

newOutput

@Nonnull
 @CheckReturnValue
public abstract Streamer.Output newOutput(@Nonnull
                                                                        OutputStream outputStream,
                                                                        @Nonnull
                                                                        Optional<Charset> charset)

Returns a new output.

Parameters:

outputStream - An output stream.

charset - An optional charset.

Returns:

The new output.

setUp

@CheckReturnValue
public abstract 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.

tearDown

public abstract void tearDown()

Tears down what has been set up.

toXML

@Nonnull
 @CheckReturnValue
public XMLElement toXML(@Nullable
                                                      Serializable serializable)

Returns a serializable as an XML element.

Parameters:

serializable - The serializable.

Returns:

The XML element.