public class OptionsBuilder extends Object implements Options, ChainedOptionsBuilder
| Constructor and Description |
|---|
OptionsBuilder() |
| Modifier and Type | Method and Description |
|---|---|
ChainedOptionsBuilder |
addProfiler(Class<? extends Profiler> prof)
Add the profiler in the run
|
ChainedOptionsBuilder |
addProfiler(Class<? extends Profiler> prof,
String initLine)
Add the profiler in the run
|
ChainedOptionsBuilder |
addProfiler(String prof)
Add the profiler in the run
|
ChainedOptionsBuilder |
addProfiler(String prof,
String initLine)
Add the profiler in the run
|
Options |
build()
Produce the final Options
|
ChainedOptionsBuilder |
detectJvmArgs()
Autodetect forked JVM arguments from the parent VM.
|
ChainedOptionsBuilder |
exclude(String regexp)
Exclude benchmarks from the run
(Can be used multiple times)
|
ChainedOptionsBuilder |
forks(int value)
Number of forks to use in the run
|
Collection<Mode> |
getBenchModes()
Benchmarks modes to execute.
|
List<String> |
getExcludes()
Which benchmarks to omit?
|
Optional<Integer> |
getForkCount()
Fork count
|
List<String> |
getIncludes()
Which benchmarks to execute?
|
Optional<String> |
getJvm()
JVM executable to use for forks
|
Optional<Collection<String>> |
getJvmArgs()
JVM parameters to use with forks
|
Optional<Collection<String>> |
getJvmArgsAppend()
JVM parameters to use with forks (these options will be appended
after any other JVM option)
|
Optional<Collection<String>> |
getJvmArgsPrepend()
JVM parameters to use with forks (these options will be prepended
before any other JVM option)
|
Optional<Integer> |
getMeasurementBatchSize()
Number of batch size for measurement
|
Optional<Integer> |
getMeasurementIterations()
Number of measurement iterations
|
Optional<TimeValue> |
getMeasurementTime()
The duration for measurement iterations
|
Optional<Integer> |
getOperationsPerInvocation()
Operations per invocation.
|
Optional<String> |
getOutput()
Which file to use for dumping the output
|
Optional<Collection<String>> |
getParameter(String name)
The overridden value of the parameter.
|
List<ProfilerConfig> |
getProfilers()
Profilers to use for the run.
|
Optional<String> |
getResult()
Which file to use for dumping the result
|
Optional<ResultFormatType> |
getResultFormat()
Result format to use
|
Optional<int[]> |
getThreadGroups()
Thread subgroups distribution.
|
Optional<Integer> |
getThreads()
Number of threads to run
|
Optional<TimeValue> |
getTimeout()
Timeout: how long to wait for an iteration to complete.
|
Optional<TimeUnit> |
getTimeUnit()
Timeunit to use in units.
|
Optional<Integer> |
getWarmupBatchSize()
Number of batch size for warmup
|
Optional<Integer> |
getWarmupForkCount()
Number of initial forks to ignore the results for
|
List<String> |
getWarmupIncludes()
Which benchmarks to warmup before doing the run.
|
Optional<Integer> |
getWarmupIterations()
Number of warmup iterations
|
Optional<WarmupMode> |
getWarmupMode()
Warmup mode.
|
Optional<TimeValue> |
getWarmupTime()
The duration for warmup iterations
|
ChainedOptionsBuilder |
include(String regexp)
Include benchmark in the run
(Can be used multiple times)
|
ChainedOptionsBuilder |
includeWarmup(String regexp)
What other benchmarks to warmup along the way
|
ChainedOptionsBuilder |
jvm(String path)
Forked JVM to use.
|
ChainedOptionsBuilder |
jvmArgs(String... value)
Forked JVM arguments.
|
ChainedOptionsBuilder |
jvmArgsAppend(String... value)
Append forked JVM arguments:
These options go after other options.
|
ChainedOptionsBuilder |
jvmArgsPrepend(String... value)
Prepend forked JVM arguments:
These options go before any other options.
|
ChainedOptionsBuilder |
measurementBatchSize(int value)
How large measurement batchSize should be?
|
ChainedOptionsBuilder |
measurementIterations(int count)
How many measurement measurementIterations to do
|
ChainedOptionsBuilder |
measurementTime(TimeValue value)
How long each measurement iteration should take?
|
ChainedOptionsBuilder |
mode(Mode mode)
Benchmark mode.
|
ChainedOptionsBuilder |
operationsPerInvocation(int opsPerInv)
Operations per invocation.
|
ChainedOptionsBuilder |
output(String filename)
Output filename to write the run log to
|
ChainedOptionsBuilder |
param(String name,
String... values)
Set benchmark parameter values.
|
ChainedOptionsBuilder |
parent(Options other)
Override the defaults from the given option.
|
ChainedOptionsBuilder |
result(String filename)
Output filename to write the result to
|
ChainedOptionsBuilder |
resultFormat(ResultFormatType type)
ResultFormatType to use in the run
|
Optional<Boolean> |
shouldDoGC()
Should force GC between iterations?
|
ChainedOptionsBuilder |
shouldDoGC(boolean value)
Should do GC between measurementIterations?
|
Optional<Boolean> |
shouldFailOnError()
Should harness terminate on first error encountered?
|
ChainedOptionsBuilder |
shouldFailOnError(boolean value)
Should fail on first benchmark error?
|
Optional<Boolean> |
shouldSyncIterations()
Should synchronize iterations?
|
ChainedOptionsBuilder |
syncIterations(boolean value)
Should synchronize measurementIterations?
|
ChainedOptionsBuilder |
threadGroups(int... groups)
Subgroups thread distribution.
|
ChainedOptionsBuilder |
threads(int count)
Number of threads to run the benchmark in
|
ChainedOptionsBuilder |
timeout(TimeValue value)
How long to wait for iteration execution?
|
ChainedOptionsBuilder |
timeUnit(TimeUnit tu)
Timeunit to use in results
|
Optional<VerboseMode> |
verbosity()
How verbose should we be?
|
ChainedOptionsBuilder |
verbosity(VerboseMode mode)
Control verbosity level.
|
ChainedOptionsBuilder |
warmupBatchSize(int value)
How large warmup batchSize should be?
|
ChainedOptionsBuilder |
warmupForks(int value)
Number of ignored forks
|
ChainedOptionsBuilder |
warmupIterations(int value)
How many warmup iterations to do?
|
ChainedOptionsBuilder |
warmupMode(WarmupMode mode)
Warmup mode to use
|
ChainedOptionsBuilder |
warmupTime(TimeValue value)
How long each warmup iteration should take?
|
public Options build()
ChainedOptionsBuilderbuild in interface ChainedOptionsBuilderpublic ChainedOptionsBuilder parent(Options other)
ChainedOptionsBuilderparent in interface ChainedOptionsBuilderother - options to base onpublic ChainedOptionsBuilder include(String regexp)
ChainedOptionsBuilderinclude in interface ChainedOptionsBuilderregexp - to match benchmarks againstpublic List<String> getIncludes()
OptionsgetIncludes in interface Optionspublic ChainedOptionsBuilder exclude(String regexp)
ChainedOptionsBuilderexclude in interface ChainedOptionsBuilderregexp - to match benchmark againstpublic List<String> getExcludes()
OptionsgetExcludes in interface Optionspublic ChainedOptionsBuilder output(String filename)
ChainedOptionsBuilderoutput in interface ChainedOptionsBuilderfilename - file namepublic Optional<String> getOutput()
Optionspublic ChainedOptionsBuilder resultFormat(ResultFormatType type)
ChainedOptionsBuilderresultFormat in interface ChainedOptionsBuildertype - resultformat typepublic Optional<ResultFormatType> getResultFormat()
OptionsgetResultFormat in interface Optionspublic ChainedOptionsBuilder result(String filename)
ChainedOptionsBuilderresult in interface ChainedOptionsBuilderfilename - file namepublic Optional<String> getResult()
Optionspublic ChainedOptionsBuilder shouldDoGC(boolean value)
ChainedOptionsBuildershouldDoGC in interface ChainedOptionsBuildervalue - flagpublic Optional<Boolean> shouldDoGC()
OptionsshouldDoGC in interface Optionspublic ChainedOptionsBuilder addProfiler(Class<? extends Profiler> prof)
ChainedOptionsBuilderaddProfiler in interface ChainedOptionsBuilderprof - profiler classpublic ChainedOptionsBuilder addProfiler(Class<? extends Profiler> prof, String initLine)
ChainedOptionsBuilderaddProfiler in interface ChainedOptionsBuilderprof - profiler classinitLine - profiler options initialization linepublic ChainedOptionsBuilder addProfiler(String prof)
ChainedOptionsBuilderaddProfiler in interface ChainedOptionsBuilderprof - profiler class name, or profiler aliaspublic ChainedOptionsBuilder addProfiler(String prof, String initLine)
ChainedOptionsBuilderaddProfiler in interface ChainedOptionsBuilderprof - profiler class name, or profiler aliasinitLine - profiler options initialization linepublic List<ProfilerConfig> getProfilers()
OptionsgetProfilers in interface Optionspublic ChainedOptionsBuilder verbosity(VerboseMode mode)
ChainedOptionsBuilderverbosity in interface ChainedOptionsBuildermode - flagpublic Optional<VerboseMode> verbosity()
Optionspublic ChainedOptionsBuilder shouldFailOnError(boolean value)
ChainedOptionsBuildershouldFailOnError in interface ChainedOptionsBuildervalue - flagpublic Optional<Boolean> shouldFailOnError()
OptionsshouldFailOnError in interface Optionspublic ChainedOptionsBuilder threads(int count)
ChainedOptionsBuilderthreads in interface ChainedOptionsBuildercount - number of threadsThreadspublic Optional<Integer> getThreads()
OptionsgetThreads in interface OptionsThreadspublic ChainedOptionsBuilder threadGroups(int... groups)
ChainedOptionsBuilderthreadGroups in interface ChainedOptionsBuildergroups - thread distributionGroup,
GroupThreadspublic Optional<int[]> getThreadGroups()
OptionsgetThreadGroups in interface OptionsGroup,
GroupThreadspublic ChainedOptionsBuilder syncIterations(boolean value)
ChainedOptionsBuildersyncIterations in interface ChainedOptionsBuildervalue - flagpublic Optional<Boolean> shouldSyncIterations()
OptionsshouldSyncIterations in interface Optionspublic ChainedOptionsBuilder warmupIterations(int value)
ChainedOptionsBuilderwarmupIterations in interface ChainedOptionsBuildervalue - flagWarmuppublic Optional<Integer> getWarmupIterations()
OptionsgetWarmupIterations in interface OptionsWarmuppublic ChainedOptionsBuilder warmupBatchSize(int value)
ChainedOptionsBuilderwarmupBatchSize in interface ChainedOptionsBuildervalue - batch sizeWarmuppublic Optional<Integer> getWarmupBatchSize()
OptionsgetWarmupBatchSize in interface OptionsWarmuppublic ChainedOptionsBuilder warmupTime(TimeValue value)
ChainedOptionsBuilderwarmupTime in interface ChainedOptionsBuildervalue - timeWarmuppublic Optional<TimeValue> getWarmupTime()
OptionsgetWarmupTime in interface OptionsWarmuppublic ChainedOptionsBuilder warmupMode(WarmupMode mode)
ChainedOptionsBuilderwarmupMode in interface ChainedOptionsBuildermode - to usepublic Optional<WarmupMode> getWarmupMode()
OptionsgetWarmupMode in interface OptionsWarmupModepublic ChainedOptionsBuilder includeWarmup(String regexp)
ChainedOptionsBuilderincludeWarmup in interface ChainedOptionsBuilderregexp - to match benchmarks againstpublic List<String> getWarmupIncludes()
OptionsgetWarmupIncludes in interface Optionspublic ChainedOptionsBuilder measurementIterations(int count)
ChainedOptionsBuildermeasurementIterations in interface ChainedOptionsBuildercount - number of iterationsMeasurementpublic Optional<Integer> getMeasurementIterations()
OptionsgetMeasurementIterations in interface OptionsMeasurementpublic ChainedOptionsBuilder measurementTime(TimeValue value)
ChainedOptionsBuildermeasurementTime in interface ChainedOptionsBuildervalue - timeMeasurementpublic Optional<TimeValue> getMeasurementTime()
OptionsgetMeasurementTime in interface OptionsMeasurementpublic ChainedOptionsBuilder measurementBatchSize(int value)
ChainedOptionsBuildermeasurementBatchSize in interface ChainedOptionsBuildervalue - batch sizeMeasurementpublic Optional<Integer> getMeasurementBatchSize()
OptionsgetMeasurementBatchSize in interface OptionsMeasurementpublic ChainedOptionsBuilder mode(Mode mode)
ChainedOptionsBuildermode in interface ChainedOptionsBuildermode - benchmark modeBenchmarkModepublic Collection<Mode> getBenchModes()
OptionsgetBenchModes in interface OptionsBenchmarkModepublic ChainedOptionsBuilder timeUnit(TimeUnit tu)
ChainedOptionsBuildertimeUnit in interface ChainedOptionsBuildertu - time unitOutputTimeUnitpublic Optional<TimeUnit> getTimeUnit()
OptionsgetTimeUnit in interface OptionsOutputTimeUnitpublic ChainedOptionsBuilder operationsPerInvocation(int opsPerInv)
ChainedOptionsBuilderoperationsPerInvocation in interface ChainedOptionsBuilderopsPerInv - operations per invocation.OperationsPerInvocationpublic Optional<Integer> getOperationsPerInvocation()
OptionsgetOperationsPerInvocation in interface OptionsOperationsPerInvocationpublic ChainedOptionsBuilder forks(int value)
ChainedOptionsBuilderforks in interface ChainedOptionsBuildervalue - number of forksForkpublic Optional<Integer> getForkCount()
OptionsgetForkCount in interface OptionsForkpublic ChainedOptionsBuilder warmupForks(int value)
ChainedOptionsBuilderwarmupForks in interface ChainedOptionsBuildervalue - number of ignored forksForkpublic Optional<Integer> getWarmupForkCount()
OptionsgetWarmupForkCount in interface OptionsForkpublic ChainedOptionsBuilder jvm(String path)
ChainedOptionsBuilderjvm in interface ChainedOptionsBuilderpath - path to /bin/javapublic Optional<String> getJvm()
Optionspublic ChainedOptionsBuilder jvmArgs(String... value)
ChainedOptionsBuilderjvmArgs in interface ChainedOptionsBuildervalue - arguments to add to the runForkpublic Optional<Collection<String>> getJvmArgs()
OptionsgetJvmArgs in interface OptionsForkpublic ChainedOptionsBuilder jvmArgsAppend(String... value)
ChainedOptionsBuilderjvmArgsAppend in interface ChainedOptionsBuildervalue - arguments to add to the runForkpublic Optional<Collection<String>> getJvmArgsAppend()
OptionsgetJvmArgsAppend in interface OptionsForkpublic ChainedOptionsBuilder jvmArgsPrepend(String... value)
ChainedOptionsBuilderjvmArgsPrepend in interface ChainedOptionsBuildervalue - arguments to add to the runForkpublic Optional<Collection<String>> getJvmArgsPrepend()
OptionsgetJvmArgsPrepend in interface OptionsForkpublic ChainedOptionsBuilder detectJvmArgs()
ChainedOptionsBuilderdetectJvmArgs in interface ChainedOptionsBuilderpublic Optional<Collection<String>> getParameter(String name)
OptionsgetParameter in interface Optionsname - parameter nameParampublic ChainedOptionsBuilder param(String name, String... values)
ChainedOptionsBuilderparam in interface ChainedOptionsBuildername - parametervalues - sequence of values to setParampublic ChainedOptionsBuilder timeout(TimeValue value)
ChainedOptionsBuildertimeout in interface ChainedOptionsBuildervalue - timepublic Optional<TimeValue> getTimeout()
OptionsgetTimeout in interface OptionsCopyright © 2012-2015 Oracle. All Rights Reserved.