org.optaplanner.core.impl.solution
Interface ProblemIO

public interface ProblemIO

Reads or writes a Solution from or to a File.

Every implementation must be thread-safe.

Method Summary

String	getFileExtension() Every Solution type potentially has its own file extension.
Solution	read(File inputSolutionFile) This method is thread-safe.
void	write(Solution solution, File outputSolutionFile) This method is thread-safe.

Method Detail

getFileExtension

String getFileExtension()

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

• If this ProblemIO implementation serializes to XML, use file extension "xml".
• If this ProblemIO implementation serializes to text, use file extension "txt".
• If this ProblemIO 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 an output file should be able to function as an input file. If that isn't the case, this method should return the output file extension.

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

This method is thread-safe.

Returns:

never null, for example "xml"

read

Solution read(File inputSolutionFile)

This method is thread-safe.

Parameters:

inputSolutionFile - never null

Returns:

never null

write

void write(Solution solution,
           File outputSolutionFile)

This method is thread-safe.

Parameters:

solution - never null

outputSolutionFile - never null, parent directory already exists