Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| OptaPlanner distribution 6.1.0.Final
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.optaplanner.persistence.common.api.domain.solution
Interface SolutionFileIO

All Known Implementing Classes:
  MachineReassignmentFileIO, TspFileIO, VehicleRoutingFileIO, XStreamSolutionFileIO

    public interface SolutionFileIO

Reads or writes a `Solution` from or to a `File`.

An implementation must be thread-safe.

Method Summary
`String` | `getInputFileExtension()` It's highly recommended that this method returns the same value as `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.

Method Detail

### getInputFileExtension

    String getInputFileExtension()

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

  Returns:
    never null, for example "xml"
  See Also:
    `getOutputFileExtension()`

### getOutputFileExtension

    String getOutputFileExtension()

  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 `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.

  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

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
| OptaPlanner distribution 6.1.0.Final
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

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