## Uses of Class
org.optaplanner.benchmark.api.PlannerBenchmarkFactory

- Packages that use PlannerBenchmarkFactory
  Package | Description
  --- | ---
  org.optaplanner.benchmark.api | The public API of OptaPlanner Benchmark.
  org.optaplanner.benchmark.impl | Implementation classes of OptaPlanner Benchmark.
  org.optaplanner.benchmark.impl.aggregator.swingui |

- - ### Uses of PlannerBenchmarkFactory in org.optaplanner.benchmark.api

    Methods in org.optaplanner.benchmark.api that return PlannerBenchmarkFactory
    Modifier and Type | Method | Description
    --- | --- | ---
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`create​(PlannerBenchmarkConfig benchmarkConfig)` | Uses a `PlannerBenchmarkConfig` to build a `PlannerBenchmarkFactory`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlFile​(File templateFile)` | Reads an Freemarker template rom the file system that generates an XML benchmark configuration and uses that `PlannerBenchmarkConfig` to build a `PlannerBenchmarkFactory`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlFile​(File templateFile, ClassLoader classLoader)` | As defined by `createFromFreemarkerXmlFile(File)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlFile​(File templateFile, Object model)` | As defined by `createFromFreemarkerXmlFile(File)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlFile​(File templateFile, Object model, ClassLoader classLoader)` | As defined by `createFromFreemarkerXmlFile(File)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlInputStream​(InputStream templateIn)` | Deprecated. in favor of `PlannerBenchmarkConfig.createFromFreemarkerXmlInputStream(InputStream)` and `create(PlannerBenchmarkConfig)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlInputStream​(InputStream templateIn, ClassLoader classLoader)` | Deprecated. in favor of `PlannerBenchmarkConfig.createFromFreemarkerXmlInputStream(InputStream, ClassLoader)` and `create(PlannerBenchmarkConfig)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlInputStream​(InputStream templateIn, Object model)` | Deprecated. in favor of `PlannerBenchmarkConfig.createFromFreemarkerXmlInputStream(InputStream, Object)` and `create(PlannerBenchmarkConfig)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlInputStream​(InputStream templateIn, Object model, ClassLoader classLoader)` | Deprecated. in favor of `PlannerBenchmarkConfig.createFromFreemarkerXmlInputStream(InputStream, Object, ClassLoader)` and `create(PlannerBenchmarkConfig)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlReader​(Reader templateReader)` | Deprecated. in favor of `PlannerBenchmarkConfig.createFromFreemarkerXmlReader(Reader)` and `create(PlannerBenchmarkConfig)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlReader​(Reader templateReader, ClassLoader classLoader)` | Deprecated. in favor of `PlannerBenchmarkConfig.createFromFreemarkerXmlReader(Reader, ClassLoader)` and `create(PlannerBenchmarkConfig)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlReader​(Reader templateReader, Object model)` | Deprecated. in favor of `PlannerBenchmarkConfig.createFromFreemarkerXmlReader(Reader, Object)` and `create(PlannerBenchmarkConfig)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlReader​(Reader templateReader, Object model, ClassLoader classLoader)` | Deprecated. in favor of `PlannerBenchmarkConfig.createFromFreemarkerXmlReader(Reader, Object, ClassLoader)` and `create(PlannerBenchmarkConfig)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlResource​(String templateResource)` | Reads an Freemarker template from the classpath that generates an XML benchmark configuration and uses that `PlannerBenchmarkConfig` to build a `PlannerBenchmarkFactory`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlResource​(String templateResource, ClassLoader classLoader)` | As defined by `createFromFreemarkerXmlResource(String)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlResource​(String templateResource, Object model)` | As defined by `createFromFreemarkerXmlResource(String)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromFreemarkerXmlResource​(String templateResource, Object model, ClassLoader classLoader)` | As defined by `createFromFreemarkerXmlResource(String)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromKieContainerXmlResource​(String benchmarkConfigResource)` | Creates a new `PlannerBenchmarkFactory` that uses `KieServices.getKieClasspathContainer()`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromKieContainerXmlResource​(org.kie.api.builder.ReleaseId releaseId, String benchmarkConfigResource)` | Creates a new `PlannerBenchmarkFactory` that uses a `KieModule` represented by its releaseId.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromKieContainerXmlResource​(org.kie.api.runtime.KieContainer kieContainer, String benchmarkConfigResource)` | Creates a new `PlannerBenchmarkFactory` that uses a `KieModule` wrapped by a `KieContainer`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromSolverConfigXmlResource​(String solverConfigResource)` | Reads an XML solver configuration from the classpath and uses that `SolverConfig` to build a `PlannerBenchmarkConfig` that in turn is used to build a `PlannerBenchmarkFactory`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromSolverConfigXmlResource​(String solverConfigResource, File benchmarkDirectory)` | As defined by `createFromSolverConfigXmlResource(String)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromSolverConfigXmlResource​(String solverConfigResource, File benchmarkDirectory, ClassLoader classLoader)` | As defined by `createFromSolverConfigXmlResource(String)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromSolverConfigXmlResource​(String solverConfigResource, ClassLoader classLoader)` | As defined by `createFromSolverConfigXmlResource(String)`.
    `static <Solution_> PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromSolverFactory​(SolverFactory<Solution_> solverFactory)` | Deprecated. in favor of `createFromSolverConfigXmlResource(String)` or in complex cases `PlannerBenchmarkConfig.createFromSolverConfig(SolverConfig)` and `create(PlannerBenchmarkConfig)`.
    `static <Solution_> PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromSolverFactory​(SolverFactory<Solution_> solverFactory, File benchmarkDirectory)` | Deprecated. in favor of `createFromSolverConfigXmlResource(String, File)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromXmlFile​(File benchmarkConfigFile)` | Reads an XML benchmark configuration from the file system and uses that `PlannerBenchmarkConfig` to build a `PlannerBenchmarkFactory`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromXmlFile​(File benchmarkConfigFile, ClassLoader classLoader)` | As defined by `createFromXmlFile(File)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromXmlInputStream​(InputStream in)` | Deprecated. in favor of `PlannerBenchmarkConfig.createFromXmlInputStream(InputStream)` and `create(PlannerBenchmarkConfig)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromXmlInputStream​(InputStream in, ClassLoader classLoader)` | Deprecated. in favor of `PlannerBenchmarkConfig.createFromXmlInputStream(InputStream, ClassLoader)` and `create(PlannerBenchmarkConfig)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromXmlReader​(Reader reader)` | Deprecated. in favor of `PlannerBenchmarkConfig.createFromXmlReader(Reader)` and `create(PlannerBenchmarkConfig)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromXmlReader​(Reader reader, ClassLoader classLoader)` | Deprecated. in favor of `PlannerBenchmarkConfig.createFromXmlReader(Reader, ClassLoader)` and `create(PlannerBenchmarkConfig)`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromXmlResource​(String benchmarkConfigResource)` | Reads an XML benchmark configuration from the classpath and uses that `PlannerBenchmarkConfig` to build a `PlannerBenchmarkFactory`.
    `static PlannerBenchmarkFactory` | PlannerBenchmarkFactory.`createFromXmlResource​(String benchmarkConfigResource, ClassLoader classLoader)` | As defined by `createFromXmlResource(String)`.

  - ### Uses of PlannerBenchmarkFactory in org.optaplanner.benchmark.impl

    Subclasses of PlannerBenchmarkFactory in org.optaplanner.benchmark.impl
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `DefaultPlannerBenchmarkFactory` |

  - ### Uses of PlannerBenchmarkFactory in org.optaplanner.benchmark.impl.aggregator.swingui

    Methods in org.optaplanner.benchmark.impl.aggregator.swingui with parameters of type PlannerBenchmarkFactory
    Modifier and Type | Method | Description
    --- | --- | ---
    `static void` | BenchmarkAggregatorFrame.`createAndDisplay​(PlannerBenchmarkFactory benchmarkFactory)` | Deprecated. in favor of `BenchmarkAggregatorFrame.createAndDisplayFromXmlResource(String)` or `BenchmarkAggregatorFrame.createAndDisplay(PlannerBenchmarkConfig)`.