Package org.openjdk.jmh.runner.options

Interface Options

    • 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

      • 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

      • 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

      • 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

      • 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