Package org.teavm.perf

Enum Class BenchmarkMode

java.lang.Object

java.lang.Enum<BenchmarkMode>

org.teavm.perf.BenchmarkMode

All Implemented Interfaces:

Serializable, Comparable<BenchmarkMode>, Constable

public enum BenchmarkMode
extends Enum<BenchmarkMode>

Subset of JMH benchmark modes supported by TeaVM benchmark runner.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AVERAGE_TIME
SINGLE_SHOT_TIME
THROUGHPUT

Method Summary

Modifier and Type	Method	Description
String	getJmhName()
String	getShortLabel()
boolean	isHigherBetter()
static BenchmarkMode	parse(String text)	Parses mode the way JMH does, i.e. accepts both short label (e.g.
static TimeUnit	parseTimeUnit(String text)
static String	timeUnitLabel(TimeUnit timeUnit)
String	unit(TimeUnit timeUnit)
static BenchmarkMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BenchmarkMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

THROUGHPUT

public static final BenchmarkMode THROUGHPUT

AVERAGE_TIME

public static final BenchmarkMode AVERAGE_TIME

SINGLE_SHOT_TIME

public static final BenchmarkMode SINGLE_SHOT_TIME

Method Details

values

public static BenchmarkMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static BenchmarkMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getShortLabel

public String getShortLabel()

getJmhName

public String getJmhName()

unit

public String unit(TimeUnit timeUnit)

isHigherBetter

public boolean isHigherBetter()

parse

public static BenchmarkMode parse(String text)

Parses mode the way JMH does, i.e. accepts both short label (e.g. avgt) and name of the constant of JMH's Mode enum (e.g. AverageTime).

Returns:

parsed mode or null, if mode is not supported.

timeUnitLabel

public static String timeUnitLabel(TimeUnit timeUnit)

parseTimeUnit

public static TimeUnit parseTimeUnit(String text)