Package de.cuioss.benchmarking.common.config

Class BenchmarkConfiguration.Builder

java.lang.Object

de.cuioss.benchmarking.common.config.BenchmarkConfiguration.Builder

Enclosing class:

BenchmarkConfiguration

public static class BenchmarkConfiguration.Builder
extends Object

Builder for BenchmarkConfiguration.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BenchmarkConfiguration	build()	Builds the configuration.
BenchmarkConfiguration.Builder	withBenchmarkType(BenchmarkType type)	Convenience method to set benchmark type for report config.
BenchmarkConfiguration.Builder	withForks(int forks)
BenchmarkConfiguration.Builder	withIncludePattern(String pattern)
BenchmarkConfiguration.Builder	withIntegrationConfig(IntegrationConfiguration config)	Sets the integration configuration for integration benchmarks.
BenchmarkConfiguration.Builder	withLatencyBenchmarkName(String name)	Convenience method to set latency benchmark name.
BenchmarkConfiguration.Builder	withMeasurementIterations(int iterations)
BenchmarkConfiguration.Builder	withMeasurementTime(org.openjdk.jmh.runner.options.TimeValue time)
BenchmarkConfiguration.Builder	withProjectName(String name)	Convenience method to set project name for dashboard display.
BenchmarkConfiguration.Builder	withReportConfig(ReportConfiguration config)	Sets the complete report configuration.
BenchmarkConfiguration.Builder	withResultFile(String file)	Convenience method to set result file.
BenchmarkConfiguration.Builder	withResultFormat(org.openjdk.jmh.results.format.ResultFormatType format)	Convenience method to set result format.
BenchmarkConfiguration.Builder	withResultsDirectory(String dir)	Convenience method to set results directory.
BenchmarkConfiguration.Builder	withThreads(int threads)
BenchmarkConfiguration.Builder	withThroughputBenchmarkName(String name)	Convenience method to set throughput benchmark name.
BenchmarkConfiguration.Builder	withWarmupIterations(int iterations)
BenchmarkConfiguration.Builder	withWarmupTime(org.openjdk.jmh.runner.options.TimeValue time)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

withReportConfig

public BenchmarkConfiguration.Builder withReportConfig(ReportConfiguration config)

Sets the complete report configuration.

withBenchmarkType

public BenchmarkConfiguration.Builder withBenchmarkType(BenchmarkType type)

Convenience method to set benchmark type for report config. Creates a report config builder if needed.

withThroughputBenchmarkName

public BenchmarkConfiguration.Builder withThroughputBenchmarkName(String name)

Convenience method to set throughput benchmark name. Creates a report config builder if needed.

withLatencyBenchmarkName

public BenchmarkConfiguration.Builder withLatencyBenchmarkName(String name)

Convenience method to set latency benchmark name. Creates a report config builder if needed.

withResultsDirectory

public BenchmarkConfiguration.Builder withResultsDirectory(String dir)

Convenience method to set results directory. Creates a report config builder if needed.

withResultFile

public BenchmarkConfiguration.Builder withResultFile(String file)

Convenience method to set result file. Creates a report config builder if needed.

withResultFormat

public BenchmarkConfiguration.Builder withResultFormat(org.openjdk.jmh.results.format.ResultFormatType format)

Convenience method to set result format. Creates a report config builder if needed.

withProjectName

public BenchmarkConfiguration.Builder withProjectName(String name)

Convenience method to set project name for dashboard display. Creates a report config builder if needed.

withIncludePattern

public BenchmarkConfiguration.Builder withIncludePattern(String pattern)

withForks

public BenchmarkConfiguration.Builder withForks(int forks)

withWarmupIterations

public BenchmarkConfiguration.Builder withWarmupIterations(int iterations)

withMeasurementIterations

public BenchmarkConfiguration.Builder withMeasurementIterations(int iterations)

withMeasurementTime

public BenchmarkConfiguration.Builder withMeasurementTime(org.openjdk.jmh.runner.options.TimeValue time)

withWarmupTime

public BenchmarkConfiguration.Builder withWarmupTime(org.openjdk.jmh.runner.options.TimeValue time)

withThreads

public BenchmarkConfiguration.Builder withThreads(int threads)

withIntegrationConfig

public BenchmarkConfiguration.Builder withIntegrationConfig(IntegrationConfiguration config)

Sets the integration configuration for integration benchmarks. This configuration contains URLs needed for integration testing.

build

public BenchmarkConfiguration build()

Builds the configuration.

Returns:

the built configuration

Throws:

IllegalArgumentException - if required fields are not set