org.openjdk.jmh.runner.options.Options Maven / Gradle / Ivy
/*
* Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package org.openjdk.jmh.runner.options;
import org.openjdk.jmh.annotations.Mode;
import org.openjdk.jmh.results.format.ResultFormatType;
import org.openjdk.jmh.util.Optional;
import java.io.Serializable;
import java.util.Collection;
import java.util.List;
import java.util.concurrent.TimeUnit;
public interface Options extends Serializable {
/**
* Which benchmarks to execute?
* @return list of regexps matching the requested benchmarks
*/
List getIncludes();
/**
* Which benchmarks to omit?
* @return list of regexps matching the ignored benchmarks
*/
List getExcludes();
/**
* Which file to use for dumping the output
* @return file name
*/
Optional getOutput();
/**
* Result format to use
* @return format type
*/
Optional getResultFormat();
/**
* Which file to use for dumping the result
* @return file name
*/
Optional getResult();
/**
* Should force GC between iterations?
* @return should GC?
*/
Optional shouldDoGC();
/**
* Profilers to use for the run.
* Profilers will start in the order specified by collection, and will stop in the reverse order.
* @return profilers to use; empty collection if no profilers are required
*/
List getProfilers();
/**
* How verbose should we be?
* @return verbosity mode
*/
Optional verbosity();
/**
* Should harness terminate on first error encountered?
* @return should terminate?
*/
Optional shouldFailOnError();
/**
* Number of threads to run
* @return number of threads; 0 to use maximum number of threads
* @see org.openjdk.jmh.annotations.Threads
*/
Optional getThreads();
/**
* Thread subgroups distribution.
* @return array of thread ratios
* @see org.openjdk.jmh.annotations.Group
* @see org.openjdk.jmh.annotations.GroupThreads
*/
Optional getThreadGroups();
/**
* Should synchronize iterations?
* @return should we?
*/
Optional shouldSyncIterations();
/**
* Number of warmup iterations
* @return number of warmup iterations
* @see org.openjdk.jmh.annotations.Warmup
*/
Optional getWarmupIterations();
/**
* The duration for warmup iterations
* @return duration
* @see org.openjdk.jmh.annotations.Warmup
*/
Optional getWarmupTime();
/**
* Number of batch size for warmup
* @return number of batch size for warmup
* @see org.openjdk.jmh.annotations.Warmup
*/
Optional getWarmupBatchSize();
/**
* Warmup mode.
* @return warmup mode
* @see org.openjdk.jmh.runner.options.WarmupMode
*/
Optional getWarmupMode();
/**
* Which benchmarks to warmup before doing the run.
* @return list of regexps matching the relevant benchmarks; empty if no benchmarks are defined
*/
List getWarmupIncludes();
/**
* Number of measurement iterations
* @return number of measurement iterations
* @see org.openjdk.jmh.annotations.Measurement
*/
Optional getMeasurementIterations();
/**
* The duration for measurement iterations
* @return duration
* @see org.openjdk.jmh.annotations.Measurement
*/
Optional getMeasurementTime();
/**
* Number of batch size for measurement
* @return number of batch size for measurement
* @see org.openjdk.jmh.annotations.Measurement
*/
Optional getMeasurementBatchSize();
/**
* Benchmarks modes to execute.
* @return modes to execute the benchmarks in; empty to use the default modes
* @see org.openjdk.jmh.annotations.BenchmarkMode
*/
Collection getBenchModes();
/**
* Timeunit to use in units.
* @return timeunit
* @see org.openjdk.jmh.annotations.OutputTimeUnit
*/
Optional getTimeUnit();
/**
* Operations per invocation.
* @return operations per invocation.
* @see org.openjdk.jmh.annotations.OperationsPerInvocation
*/
Optional getOperationsPerInvocation();
/**
* Fork count
* @return fork count; 0, to prohibit forking
* @see org.openjdk.jmh.annotations.Fork
*/
Optional getForkCount();
/**
* Number of initial forks to ignore the results for
* @return initial fork count; 0, to disable
* @see org.openjdk.jmh.annotations.Fork
*/
Optional getWarmupForkCount();
/**
* JVM executable to use for forks
* @return path to JVM executable
*/
Optional getJvm();
/**
* JVM parameters to use with forks
* @return JVM parameters
* @see org.openjdk.jmh.annotations.Fork
*/
Optional> getJvmArgs();
/**
* JVM parameters to use with forks (these options will be appended
* after any other JVM option)
* @return JVM parameters
* @see org.openjdk.jmh.annotations.Fork
*/
Optional> getJvmArgsAppend();
/**
* JVM parameters to use with forks (these options will be prepended
* before any other JVM option)
* @return JVM parameters
* @see org.openjdk.jmh.annotations.Fork
*/
Optional> getJvmArgsPrepend();
/**
* The overridden value of the parameter.
* @param name parameter name
* @return parameter
* @see org.openjdk.jmh.annotations.Param
*/
Optional> getParameter(String name);
/**
* Timeout: how long to wait for an iteration to complete.
* @return duration
*/
Optional getTimeout();
}