# Package org.optaplanner.benchmark.api

The public API of OptaPlanner Benchmark.

All classes in this namespace are backwards compatible in future releases (especially minor and hotfix releases). If a major version number changes, a few specific classes might not be backwards compatible, in which case the upgrade recipe will clearly document those cases.

- Interface Summary
  Interface | Description
  --- | ---
  PlannerBenchmark | A planner benchmark that runs a number of single benchmarks.

- Class Summary
  Class | Description
  --- | ---
  PlannerBenchmarkFactory | Builds `PlannerBenchmark` instances.

- Exception Summary
  Exception | Description
  --- | ---
  PlannerBenchmarkException | If at least one of the `SingleBenchmarkResult`s of a `PlannerBenchmark` fail, the `PlannerBenchmark` throws this exception after all `SingleBenchmarkResult`s are finished and the benchmark report has been written.