Options (JMH Core 1.10 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

CommandLineOptions, OptionsBuilder
```
public interface Options
extends Serializable
```

Method Summary

Methods
Modifier and Type	Method and Description
`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
`Optional<Boolean>`	`shouldDoGC()` Should force GC between iterations?
`Optional<Boolean>`	`shouldFailOnError()` Should harness terminate on first error encountered?
`Optional<Boolean>`	`shouldSyncIterations()` Should synchronize iterations?
`Optional<VerboseMode>`	`verbosity()` How verbose should we be?

- Method Detail
  - getIncludes
```
List<String> getIncludes()
```
    Which benchmarks to execute?
    
    Returns:
    list of regexps matching the requested benchmarks
  - getExcludes
```
List<String> getExcludes()
```
    Which benchmarks to omit?
    
    Returns:
    list of regexps matching the ignored benchmarks
  - getOutput
```
Optional<String> getOutput()
```
    Which file to use for dumping the output
    
    Returns:
    file name
  - getResultFormat
```
Optional<ResultFormatType> getResultFormat()
```
    Result format to use
    
    Returns:
    format type
  - getResult
```
Optional<String> getResult()
```
    Which file to use for dumping the result
    
    Returns:
    file name
  - shouldDoGC
```
Optional<Boolean> shouldDoGC()
```
    Should force GC between iterations?
    
    Returns:
    should GC?
  - getProfilers
```
List<ProfilerConfig> getProfilers()
```
    Profilers to use for the run. Profilers will start in the order specified by collection, and will stop in the reverse order.
    
    Returns:
    profilers to use; empty collection if no profilers are required
  - verbosity
```
Optional<VerboseMode> verbosity()
```
    How verbose should we be?
    
    Returns:
    verbosity mode
  - shouldFailOnError
```
Optional<Boolean> shouldFailOnError()
```
    Should harness terminate on first error encountered?
    
    Returns:
    should terminate?
  - getThreads
```
Optional<Integer> getThreads()
```
    Number of threads to run
    
    Returns:
    number of threads; 0 to use maximum number of threads
    See Also:
    Threads
  - getThreadGroups
```
Optional<int[]> getThreadGroups()
```
    Thread subgroups distribution.
    
    Returns:
    array of thread ratios
    See Also:
    Group, GroupThreads
  - shouldSyncIterations
```
Optional<Boolean> shouldSyncIterations()
```
    Should synchronize iterations?
    
    Returns:
    should we?
  - getWarmupIterations
```
Optional<Integer> getWarmupIterations()
```
    Number of warmup iterations
    
    Returns:
    number of warmup iterations
    See Also:
    Warmup
  - getWarmupTime
```
Optional<TimeValue> getWarmupTime()
```
    The duration for warmup iterations
    
    Returns:
    duration
    See Also:
    Warmup
  - getWarmupBatchSize
```
Optional<Integer> getWarmupBatchSize()
```
    Number of batch size for warmup
    
    Returns:
    number of batch size for warmup
    See Also:
    Warmup
  - getWarmupMode
```
Optional<WarmupMode> getWarmupMode()
```
    Warmup mode.
    
    Returns:
    warmup mode
    See Also:
    WarmupMode
  - getWarmupIncludes
```
List<String> getWarmupIncludes()
```
    Which benchmarks to warmup before doing the run.
    
    Returns:
    list of regexps matching the relevant benchmarks; empty if no benchmarks are defined
  - getMeasurementIterations
```
Optional<Integer> getMeasurementIterations()
```
    Number of measurement iterations
    
    Returns:
    number of measurement iterations
    See Also:
    Measurement
  - getMeasurementTime
```
Optional<TimeValue> getMeasurementTime()
```
    The duration for measurement iterations
    
    Returns:
    duration
    See Also:
    Measurement
  - getMeasurementBatchSize
```
Optional<Integer> getMeasurementBatchSize()
```
    Number of batch size for measurement
    
    Returns:
    number of batch size for measurement
    See Also:
    Measurement
  - getBenchModes
```
Collection<Mode> getBenchModes()
```
    Benchmarks modes to execute.
    
    Returns:
    modes to execute the benchmarks in; empty to use the default modes
    See Also:
    BenchmarkMode
  - getTimeUnit
```
Optional<TimeUnit> getTimeUnit()
```
    Timeunit to use in units.
    
    Returns:
    timeunit
    See Also:
    OutputTimeUnit
  - getOperationsPerInvocation
```
Optional<Integer> getOperationsPerInvocation()
```
    Operations per invocation.
    
    Returns:
    operations per invocation.
    See Also:
    OperationsPerInvocation
  - getForkCount
```
Optional<Integer> getForkCount()
```
    Fork count
    
    Returns:
    fork count; 0, to prohibit forking
    See Also:
    Fork
  - getWarmupForkCount
```
Optional<Integer> getWarmupForkCount()
```
    Number of initial forks to ignore the results for
    
    Returns:
    initial fork count; 0, to disable
    See Also:
    Fork
  - getJvm
```
Optional<String> getJvm()
```
    JVM executable to use for forks
    
    Returns:
    path to JVM executable
  - getJvmArgs
```
Optional<Collection<String>> getJvmArgs()
```
    JVM parameters to use with forks
    
    Returns:
    JVM parameters
    See Also:
    Fork
  - getJvmArgsAppend
```
Optional<Collection<String>> getJvmArgsAppend()
```
    JVM parameters to use with forks (these options will be appended after any other JVM option)
    
    Returns:
    JVM parameters
    See Also:
    Fork
  - getJvmArgsPrepend
```
Optional<Collection<String>> getJvmArgsPrepend()
```
    JVM parameters to use with forks (these options will be prepended before any other JVM option)
    
    Returns:
    JVM parameters
    See Also:
    Fork
  - getParameter
```
Optional<Collection<String>> getParameter(String name)
```
    The overridden value of the parameter.
    
    Parameters:
    name - parameter name
    
    Returns:
    parameter
    See Also:
    Param
  - getTimeout
```
Optional<TimeValue> getTimeout()
```
    Timeout: how long to wait for an iteration to complete.
    
    Returns:
    duration

Interface Options

Method Summary

Method Detail

getIncludes

getExcludes

getOutput

getResultFormat

getResult

shouldDoGC

getProfilers

verbosity

shouldFailOnError

getThreads

getThreadGroups

shouldSyncIterations

getWarmupIterations

getWarmupTime

getWarmupBatchSize

getWarmupMode

getWarmupIncludes

getMeasurementIterations

getMeasurementTime

getMeasurementBatchSize

getBenchModes

getTimeUnit

getOperationsPerInvocation

getForkCount

getWarmupForkCount

getJvm

getJvmArgs

getJvmArgsAppend

getJvmArgsPrepend

getParameter

getTimeout