org.optaplanner.core.api.solver

Class SolverFactory

java.lang.Object

org.optaplanner.core.api.solver.SolverFactory

Direct Known Subclasses:

XStreamXmlSolverFactory

public abstract class SolverFactory
extends Object

Builds Solver instances.

To build an instance, use createFromXmlResource(String) or any of the other creation methods.

Supports tweaking the configuration programmatically before a Solver instance is build.

Constructor Summary

Constructors

Constructor and Description
SolverFactory()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Solver	buildSolver() Creates a new Solver instance.
static SolverFactory	createFromXmlFile(File solverConfigFile)
static SolverFactory	createFromXmlInputStream(InputStream in)
static SolverFactory	createFromXmlReader(Reader reader)
static SolverFactory	createFromXmlResource(String solverConfigResource)
abstract SolverConfig	getSolverConfig() Allows you to problematically change the SolverConfig at runtime before building the Solver.

Methods inherited from class java.lang.Object

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

Constructor Detail

SolverFactory

public SolverFactory()

Method Detail

createFromXmlResource

public static SolverFactory createFromXmlResource(String solverConfigResource)

Parameters:

solverConfigResource - never null, a classpath resource as defined by ClassLoader.getResource(String)

Returns:

never null

createFromXmlFile

public static SolverFactory createFromXmlFile(File solverConfigFile)

Parameters:

solverConfigFile - never null

Returns:

never null

createFromXmlInputStream

public static SolverFactory createFromXmlInputStream(InputStream in)

Parameters:

in - never null, gets closed

Returns:

never null

createFromXmlReader

public static SolverFactory createFromXmlReader(Reader reader)

Parameters:

reader - never null, gets closed

Returns:

never null

getSolverConfig

public abstract SolverConfig getSolverConfig()

Allows you to problematically change the SolverConfig at runtime before building the Solver.

Returns:

never null

buildSolver

public abstract Solver buildSolver()

Creates a new Solver instance.

Returns:

never null