Package 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_>
@Deprecated(forRemoval=true) public class XStreamSolutionFileIO<Solution_> extends Object implements SolutionFileIO<Solution_>
Deprecated, for removal: This API element is subject to removal in a future version.
Prefer JAXB for serialization into XML.
Security warning: only use this class with XML files from a trusted source, because XStream is configured to allow all permissions, which can be exploited if the XML comes from an untrusted source.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected com.thoughtworks.xstream.XStream
    xStream
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    XStreamSolutionFileIO(Class... xStreamAnnotatedClasses)
    Deprecated, for removal: This API element is subject to removal in a future version.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getInputFileExtension()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Every PlanningSolution type potentially has its own file extension.
    com.thoughtworks.xstream.XStream
    getXStream()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Solution_
    read(File inputSolutionFile)
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method is thread-safe.
    Solution_
    read(InputStream inputSolutionStream)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    void
    write(Solution_ solution, File outputSolutionFile)
    Deprecated, for removal: This API element is subject to removal in a future version.
    This method is thread-safe.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.optaplanner.persistence.common.api.domain.solution.SolutionFileIO

    getOutputFileExtension

  • Field Details

    • xStream

      protected com.thoughtworks.xstream.XStream xStream
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Constructor Details

    • XStreamSolutionFileIO

      public XStreamSolutionFileIO(Class... xStreamAnnotatedClasses)
      Deprecated, for removal: This API element is subject to removal in a future version.

  • Method Details

    • getXStream

      public com.thoughtworks.xstream.XStream getXStream()
      Deprecated, for removal: This API element is subject to removal in a future version.

    • getInputFileExtension

      public String getInputFileExtension()
      Deprecated, for removal: This API element is subject to removal in a future version.
      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. Therefore SolutionFileIO.getOutputFileExtension() defaults to returning the same as this method.

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

      This method is thread-safe.

      Specified by:
      getInputFileExtension in interface SolutionFileIO<Solution_>
      Returns:
      never null, for example "xml"

    • read

      public Solution_ read(File inputSolutionFile)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Description copied from interface: SolutionFileIO
      This method is thread-safe.
      Specified by:
      read in interface SolutionFileIO<Solution_>
      Parameters:
      inputSolutionFile - never null
      Returns:
      never null

    • read

      public Solution_ read(InputStream inputSolutionStream)
      Deprecated, for removal: This API element is subject to removal in a future version.

    • write

      public void write(Solution_ solution, File outputSolutionFile)
      Deprecated, for removal: This API element is subject to removal in a future version.
      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