org.rvpf.base.xml.streamer.xstream

Class XStreamStreamer

Object

Streamer

XStreamStreamer

@NotThreadSafe
public final class XStreamStreamer
extends Streamer

XStream streamer.

Facade to (de)serialize values under an XML fragment representation. The actual work is done by XStream.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XStreamStreamer.Converter Owned Converter.

Nested classes/interfaces inherited from class Streamer

Streamer.Input, Streamer.Output, Streamer.Validated

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANNOTATED_CLASS_PROPERTY Annotated class property.
static String	CONVERTER_CLASS_PROPERTY Converter classes property.
static String	REFERENCES_PROPERTY References property.
static String	ROOT_ELEMENT Root element.

Constructor Summary

Constructors

Constructor and Description
XStreamStreamer()

Method Summary

Modifier and Type	Method and Description
XStream	getXStream() Gets the XStream instance.
Streamer.Input	newInput(File file, Optional<Charset> charset) Returns a new input.
Streamer.Input	newInput(InputStream inputStream, Optional<Charset> charset) Returns a new input.
Streamer.Input	newInput(Reader reader) Returns a new input.
Streamer.Input	newInput(XMLElement parentElement) Returns a new input.
Streamer.Output	newOutput(File file, Optional<Charset> charset) Returns a new output.
Streamer.Output	newOutput(OutputStream outputStream, Optional<Charset> charset) Returns a new output.
Streamer.Output	newOutput(Writer writer) Returns a new output.
Streamer.Output	newOutput(XMLElement parentElement) Returns a new 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 Streamer

fromXML, newInput, newInstance, toXML

Methods inherited from class Object

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

Field Detail

ANNOTATED_CLASS_PROPERTY

public static final String ANNOTATED_CLASS_PROPERTY

Annotated class property.

See Also:

Constant Field Values

CONVERTER_CLASS_PROPERTY

public static final String CONVERTER_CLASS_PROPERTY

Converter classes property.

See Also:

Constant Field Values

REFERENCES_PROPERTY

public static final String REFERENCES_PROPERTY

References property.

See Also:

Constant Field Values

ROOT_ELEMENT

public static final String ROOT_ELEMENT

Root element.

See Also:

Constant Field Values

Constructor Detail

XStreamStreamer

public XStreamStreamer()

Method Detail

getXStream

@CheckReturnValue
public XStream getXStream()

Gets the XStream instance.

Returns:

The XStream instance.

newInput

public Streamer.Input newInput(Reader reader)

Returns a new input.

Specified by:

newInput in class Streamer

Parameters:

reader - A reader.

Returns:

The new input.

newInput

public Streamer.Input newInput(XMLElement parentElement)

Returns a new input.

Specified by:

newInput in class Streamer

Parameters:

parentElement - A parent element.

Returns:

The new input.

newInput

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

Returns a new input.

Specified by:

newInput in class Streamer

Parameters:

file - An input file.

charset - An optional charset.

Returns:

The new input.

Throws:

FileNotFoundException - When the file is not found.

newInput

public Streamer.Input newInput(InputStream inputStream,
                               Optional<Charset> charset)

Returns a new input.

Specified by:

newInput in class Streamer

Parameters:

inputStream - An input stream.

charset - An optional charset.

Returns:

The new input.

newOutput

public Streamer.Output newOutput(Writer writer)

Returns a new output.

Specified by:

newOutput in class Streamer

Parameters:

writer - A writer.

Returns:

The new output.

newOutput

public Streamer.Output newOutput(XMLElement parentElement)

Returns a new output.

Specified by:

newOutput in class Streamer

Parameters:

parentElement - A parent element.

Returns:

The new output.

newOutput

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

Returns a new output.

Specified by:

newOutput in class Streamer

Parameters:

file - An output file.

charset - An optional charset.

Returns:

The new output.

Throws:

FileNotFoundException - When the file is not found.

newOutput

public Streamer.Output newOutput(OutputStream outputStream,
                                 Optional<Charset> charset)

Returns a new output.

Specified by:

newOutput in class Streamer

Parameters:

outputStream - An output stream.

charset - An optional charset.

Returns:

The new output.

setUp

public boolean setUp(Optional<KeyedGroups> configProperties,
                     Optional<KeyedValues> moduleProperties)

Sets up this.

Specified by:

setUp in class Streamer

Parameters:

configProperties - The optional Configuration properties.

moduleProperties - The optional module properties.

Returns:

True on success.

tearDown

public void tearDown()

Tears down what has been set up.

Specified by:

tearDown in class Streamer