OptaPlanner distribution 6.2.1-SNAPSHOT

org.optaplanner.examples.tsp.persistence
Class TspFileIO

java.lang.Object
  extended by org.optaplanner.examples.tsp.persistence.TspFileIO
All Implemented Interfaces:
SolutionFileIO

public class TspFileIO
extends Object
implements SolutionFileIO


Constructor Summary
TspFileIO()
           
 
Method Summary
 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 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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TspFileIO

public TspFileIO()
Method Detail

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
Returns:
never null, for example "xml"
See Also:
SolutionFileIO.getOutputFileExtension()

getOutputFileExtension

public String getOutputFileExtension()
Description copied from interface: SolutionFileIO
Every Solution type potentially has its own file extension. If no specific file extension is defined by the use case, the following are recommended:

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
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
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
Parameters:
solution - never null
outputSolutionFile - never null, parent directory already exists

OptaPlanner distribution 6.2.1-SNAPSHOT

Copyright © 2006-2015 JBoss by Red Hat. All Rights Reserved.