Package org.openjdk.jmh.runner.options
Interface ChainedOptionsBuilder
- All Known Implementing Classes:
OptionsBuilder
public interface ChainedOptionsBuilder
-
Method Summary
Modifier and TypeMethodDescriptionaddProfiler
(Class<? extends Profiler> profiler) Add the profiler in the runaddProfiler
(Class<? extends Profiler> profiler, String initLine) Add the profiler in the runaddProfiler
(String profiler) Add the profiler in the runaddProfiler
(String profiler, String initLine) Add the profiler in the runbuild()
Produce the final OptionsAutodetect forked JVM arguments from the parent VM.Exclude benchmarks from the run (Can be used multiple times)forks
(int value) Number of forks to use in the runInclude benchmark in the run (Can be used multiple times)includeWarmup
(String regexp) What other benchmarks to warmup along the wayForked JVM to use.Forked JVM arguments.jvmArgsAppend
(String... value) Append forked JVM arguments: These options go after other options.jvmArgsPrepend
(String... value) Prepend forked JVM arguments: These options go before any other options.measurementBatchSize
(int value) How large measurement batchSize should be?measurementIterations
(int count) How many measurement measurementIterations to domeasurementTime
(TimeValue value) How long each measurement iteration should take?Benchmark mode.operationsPerInvocation
(int value) Operations per invocation.Output filename to write the run log toSet benchmark parameter values.Override the defaults from the given option.Output filename to write the result toresultFormat
(ResultFormatType type) ResultFormatType to use in the runshouldDoGC
(boolean value) Should do GC between measurementIterations?shouldFailOnError
(boolean value) Should fail on first benchmark error?syncIterations
(boolean value) Should synchronize measurementIterations?threadGroups
(int... groups) Subgroups thread distribution.threads
(int count) Number of threads to run the benchmark inHow long to wait for iteration execution?Timeunit to use in resultsverbosity
(VerboseMode mode) Control verbosity level.warmupBatchSize
(int value) How large warmup batchSize should be?warmupForks
(int value) Number of ignored forkswarmupIterations
(int value) How many warmup iterations to do?warmupMode
(WarmupMode mode) Warmup mode to usewarmupTime
(TimeValue value) How long each warmup iteration should take?
-
Method Details
-
build
Options build()Produce the final Options- Returns:
- options object.
-
parent
Override the defaults from the given option. You may use this only once.- Parameters:
other
- options to base on- Returns:
- builder
-
include
Include benchmark in the run (Can be used multiple times)- Parameters:
regexp
- to match benchmarks against- Returns:
- builder
- See Also:
-
exclude
Exclude benchmarks from the run (Can be used multiple times)- Parameters:
regexp
- to match benchmark against- Returns:
- builder
-
resultFormat
ResultFormatType to use in the run- Parameters:
type
- resultformat type- Returns:
- builder
- See Also:
-
output
Output filename to write the run log to- Parameters:
filename
- file name- Returns:
- builder
-
result
Output filename to write the result to- Parameters:
filename
- file name- Returns:
- builder
- See Also:
-
shouldDoGC
Should do GC between measurementIterations?- Parameters:
value
- flag- Returns:
- builder
- See Also:
-
addProfiler
Add the profiler in the run- Parameters:
profiler
- profiler class- Returns:
- builder
-
addProfiler
Add the profiler in the run- Parameters:
profiler
- profiler classinitLine
- profiler options initialization line- Returns:
- builder
-
addProfiler
Add the profiler in the run- Parameters:
profiler
- profiler class name, or profiler alias- Returns:
- builder
-
addProfiler
Add the profiler in the run- Parameters:
profiler
- profiler class name, or profiler aliasinitLine
- profiler options initialization line- Returns:
- builder
-
verbosity
Control verbosity level.- Parameters:
mode
- flag- Returns:
- builder
- See Also:
-
shouldFailOnError
Should fail on first benchmark error?- Parameters:
value
- flag- Returns:
- builder
- See Also:
-
threads
Number of threads to run the benchmark in- Parameters:
count
- number of threads- Returns:
- builder
- See Also:
-
threadGroups
Subgroups thread distribution.- Parameters:
groups
- thread distribution- Returns:
- builder
- See Also:
-
syncIterations
Should synchronize measurementIterations?- Parameters:
value
- flag- Returns:
- builder
- See Also:
-
warmupIterations
How many warmup iterations to do?- Parameters:
value
- flag- Returns:
- builder
- See Also:
-
warmupBatchSize
How large warmup batchSize should be?- Parameters:
value
- batch size- Returns:
- builder
- See Also:
-
warmupTime
How long each warmup iteration should take?- Parameters:
value
- time- Returns:
- builder
- See Also:
-
warmupMode
Warmup mode to use- Parameters:
mode
- to use- Returns:
- builder
- See Also:
-
includeWarmup
What other benchmarks to warmup along the way- Parameters:
regexp
- to match benchmarks against- Returns:
- builder
-
measurementIterations
How many measurement measurementIterations to do- Parameters:
count
- number of iterations- Returns:
- builder
- See Also:
-
measurementBatchSize
How large measurement batchSize should be?- Parameters:
value
- batch size- Returns:
- builder
- See Also:
-
measurementTime
How long each measurement iteration should take?- Parameters:
value
- time- Returns:
- builder
- See Also:
-
mode
Benchmark mode. (Can be used multiple times)- Parameters:
mode
- benchmark mode- Returns:
- builder
- See Also:
-
timeUnit
Timeunit to use in results- Parameters:
tu
- time unit- Returns:
- builder
- See Also:
-
operationsPerInvocation
Operations per invocation.- Parameters:
value
- operations per invocation.- Returns:
- builder
- See Also:
-
forks
Number of forks to use in the run- Parameters:
value
- number of forks- Returns:
- builder
- See Also:
-
warmupForks
Number of ignored forks- Parameters:
value
- number of ignored forks- Returns:
- builder
- See Also:
-
jvm
Forked JVM to use.- Parameters:
path
- path to /bin/java- Returns:
- builder
-
jvmArgs
Forked JVM arguments.- Parameters:
value
- arguments to add to the run- Returns:
- builder
- See Also:
-
jvmArgsAppend
Append forked JVM arguments: These options go after other options.- Parameters:
value
- arguments to add to the run- Returns:
- builder
- See Also:
-
jvmArgsPrepend
Prepend forked JVM arguments: These options go before any other options.- Parameters:
value
- arguments to add to the run- Returns:
- builder
- See Also:
-
detectJvmArgs
ChainedOptionsBuilder detectJvmArgs()Autodetect forked JVM arguments from the parent VM. Overrides the jvmArgs(...) value.- Returns:
- builder
-
param
Set benchmark parameter values. The parameter values would be taken in the order given by user.- Parameters:
name
- parametervalues
- sequence of values to set- Returns:
- builder
- See Also:
-
timeout
How long to wait for iteration execution?- Parameters:
value
- time- Returns:
- builder
- See Also:
-