Package org.anchoranalysis.io.generator.serialized

Class XStreamGenerator<T>

Object

SingleFileTypeGenerator<T,T>

OneStageGenerator<T>

SerializedGenerator<T>

XStreamGenerator<T>

Type Parameters:

T - iteration-type

All Implemented Interfaces:

Generator<T>, TransformingGenerator<T,T>, ElementWriter<T>

public class XStreamGenerator<T>
extends SerializedGenerator<T>

A generator that serialized using the XStream library and format.

Constructor Summary

Constructors

Constructor	Description
XStreamGenerator()

Method Summary

Modifier and Type	Method	Description
protected String	extensionSuffix(OutputWriteSettings outputWriteSettings)	Appended to the standard "serialized" extension, to form the complete extension.
void	writeToFile(T element, OutputWriteSettings settings, Path filePath)	Write generated content for {code element} to the file filePath.

Methods inherited from class org.anchoranalysis.io.generator.serialized.SerializedGenerator

selectFileExtension

Methods inherited from class org.anchoranalysis.io.generator.OneStageGenerator

transform

Methods inherited from class org.anchoranalysis.io.generator.SingleFileTypeGenerator

write, writeWithIndex

Methods inherited from class java.lang.Object

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

Constructor Details

XStreamGenerator

public XStreamGenerator()

Method Details

writeToFile

public void writeToFile(T element,
 OutputWriteSettings settings,
 Path filePath)
                 throws OutputWriteFailedException

Description copied from class: SingleFileTypeGenerator

Write generated content for {code element} to the file filePath.

This function deliberately leaves ambiguity over what occurs if a file already exists at filePath.

Specified by:

writeToFile in class SingleFileTypeGenerator<T,T>

Parameters:

element - element to be assigned and then transformed.

settings - settings for outputting.

filePath - the path to the file to write to.

Throws:

OutputWriteFailedException - if the content cannot be written successfully.

extensionSuffix

protected String extensionSuffix(OutputWriteSettings outputWriteSettings)

Description copied from class: SerializedGenerator

Appended to the standard "serialized" extension, to form the complete extension.

Specified by:

extensionSuffix in class SerializedGenerator<T>

Parameters:

outputWriteSettings - the associated OutputWriteSettings.

Returns:

the suffix for the extension including any leading period, when appropriate. This may be the empty string if no suffix exists.