Interface Options

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    CommandLineOptions, OptionsBuilder

    public interface Options
    extends java.io.Serializable
    • Method Detail

      • getIncludes

        java.util.List<java.lang.String> getIncludes()
        Which benchmarks to execute?
        Returns:
        list of regexps matching the requested benchmarks
      • getExcludes

        java.util.List<java.lang.String> getExcludes()
        Which benchmarks to omit?
        Returns:
        list of regexps matching the ignored benchmarks
      • getOutput

        Optional<java.lang.String> getOutput()
        Which file to use for dumping the output
        Returns:
        file name
      • getResult

        Optional<java.lang.String> getResult()
        Which file to use for dumping the result
        Returns:
        file name
      • shouldDoGC

        Optional<java.lang.Boolean> shouldDoGC()
        Should force GC between iterations?
        Returns:
        should GC?
      • getProfilers

        java.util.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<java.lang.Boolean> shouldFailOnError()
        Should harness terminate on first error encountered?
        Returns:
        should terminate?
      • getThreads

        Optional<java.lang.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<java.lang.Boolean> shouldSyncIterations()
        Should synchronize iterations?
        Returns:
        should we?
      • getWarmupIterations

        Optional<java.lang.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<java.lang.Integer> getWarmupBatchSize()
        Number of batch size for warmup
        Returns:
        number of batch size for warmup
        See Also:
        Warmup
      • getWarmupIncludes

        java.util.List<java.lang.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<java.lang.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<java.lang.Integer> getMeasurementBatchSize()
        Number of batch size for measurement
        Returns:
        number of batch size for measurement
        See Also:
        Measurement
      • getBenchModes

        java.util.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<java.util.concurrent.TimeUnit> getTimeUnit()
        Timeunit to use in units.
        Returns:
        timeunit
        See Also:
        OutputTimeUnit
      • getOperationsPerInvocation

        Optional<java.lang.Integer> getOperationsPerInvocation()
        Operations per invocation.
        Returns:
        operations per invocation.
        See Also:
        OperationsPerInvocation
      • getForkCount

        Optional<java.lang.Integer> getForkCount()
        Fork count
        Returns:
        fork count; 0, to prohibit forking
        See Also:
        Fork
      • getWarmupForkCount

        Optional<java.lang.Integer> getWarmupForkCount()
        Number of initial forks to ignore the results for
        Returns:
        initial fork count; 0, to disable
        See Also:
        Fork
      • getJvm

        Optional<java.lang.String> getJvm()
        JVM executable to use for forks
        Returns:
        path to JVM executable
      • getJvmArgs

        Optional<java.util.Collection<java.lang.String>> getJvmArgs()
        JVM parameters to use with forks
        Returns:
        JVM parameters
        See Also:
        Fork
      • getJvmArgsAppend

        Optional<java.util.Collection<java.lang.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<java.util.Collection<java.lang.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<java.util.Collection<java.lang.String>> getParameter​(java.lang.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