org.optaplanner.persistence.xstream.impl.domain.solution

Class XStreamSolutionFileIO<Solution_>

java.lang.Object

org.optaplanner.persistence.xstream.impl.domain.solution.XStreamSolutionFileIO<Solution_>

Type Parameters:

Solution_ - the solution type, the class with the PlanningSolution annotation

All Implemented Interfaces:

SolutionFileIO<Solution_>

public class XStreamSolutionFileIO<Solution_>
extends Object
implements SolutionFileIO<Solution_>

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_EXTENSION
protected com.thoughtworks.xstream.XStream	xStream

Constructor Summary

Constructors

Constructor and Description
XStreamSolutionFileIO(Class... xStreamAnnotatedClasses)

Method Summary

Modifier and Type	Method and Description
String	getInputFileExtension() It's highly recommended that this method returns the same value as SolutionFileIO.getOutputFileExtension(), because a good output file is able to function as an input file.
String	getOutputFileExtension() Every PlanningSolution type potentially has its own file extension.
com.thoughtworks.xstream.XStream	getXStream()
Solution_	read(File inputSolutionFile) This method is thread-safe.
void	write(Solution_ solution, File outputSolutionFile) This method is thread-safe.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_EXTENSION

public static final String FILE_EXTENSION

See Also:

Constant Field Values

xStream

protected com.thoughtworks.xstream.XStream xStream

Constructor Detail

XStreamSolutionFileIO

public XStreamSolutionFileIO(Class... xStreamAnnotatedClasses)

Method Detail

getXStream

public com.thoughtworks.xstream.XStream getXStream()

getInputFileExtension

public String getInputFileExtension()

Description copied from interface: SolutionFileIO

It's highly recommended that this method returns the same value as SolutionFileIO.getOutputFileExtension(), because a good output file is able to function as an input file.

Specified by:

getInputFileExtension in interface SolutionFileIO<Solution_>

Returns:

never null, for example "xml"

See Also:

SolutionFileIO.getOutputFileExtension()

getOutputFileExtension

public String getOutputFileExtension()

Description copied from interface: SolutionFileIO

Every PlanningSolution type potentially has its own file extension. If no specific file extension is defined by the use case, the following are recommended:

• If this SolutionFileIO implementation serializes to XML, use file extension "xml".
• If this SolutionFileIO implementation serializes to text, use file extension "txt".
• If this SolutionFileIO implementation serializes to binary, use file extension "dat".

It's good practice that both the input and the output file have the same file extension, because a good output file is able to function as an input file.

The file extension does not include the dot that separates it from the base name.

This method is thread-safe.

Specified by:

getOutputFileExtension in interface SolutionFileIO<Solution_>

Returns:

never null, for example "xml"

read

public Solution_ read(File inputSolutionFile)

Description copied from interface: SolutionFileIO

This method is thread-safe.

Specified by:

read in interface SolutionFileIO<Solution_>

Parameters:

inputSolutionFile - never null

Returns:

never null

write

public void write(Solution_ solution,
                  File outputSolutionFile)

Description copied from interface: SolutionFileIO

This method is thread-safe.

Specified by:

write in interface SolutionFileIO<Solution_>

Parameters:

solution - never null

outputSolutionFile - never null, parent directory already exists