org.openjdk.jmh.annotations

Enum AuxCounters.Type

java.lang.Object

java.lang.Enum<AuxCounters.Type>

org.openjdk.jmh.annotations.AuxCounters.Type

All Implemented Interfaces:

Serializable, Comparable<AuxCounters.Type>

Enclosing class:

AuxCounters

public static enum AuxCounters.Type
extends Enum<AuxCounters.Type>

Enum Constant Summary

Enum Constants

Enum Constant and Description
EVENTS Counts "events", the one-off things in the lifetime of workload.
OPERATIONS Counts "operations", which should be relevant to the number of times Benchmark method was executed.

Method Summary

Modifier and Type	Method and Description
static AuxCounters.Type	valueOf(String name) Returns the enum constant of this type with the specified name.
static AuxCounters.Type[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

OPERATIONS

public static final AuxCounters.Type OPERATIONS

Counts "operations", which should be relevant to the number of times Benchmark method was executed. If this counter is incremented on each Benchmark method invocation, then it will produce a metric similar to the primary benchmark result. This counter will be normalized to benchmark time by the harness.

EVENTS

public static final AuxCounters.Type EVENTS

Counts "events", the one-off things in the lifetime of workload. This counter would not get normalized to time.

Method Detail

values

public static AuxCounters.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AuxCounters.Type c : AuxCounters.Type.values())
    System.out.println(c);

Returns:

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

valueOf

public static AuxCounters.Type valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null