org.openjdk.jmh.results

Enum ResultRole

java.lang.Object

java.lang.Enum<ResultRole>

org.openjdk.jmh.results.ResultRole

All Implemented Interfaces:

Serializable, Comparable<ResultRole>

public enum ResultRole
extends Enum<ResultRole>

Enum Constant Summary

Enum Constants

Enum Constant and Description
OMITTED Does not participate in any metric, garbage result.
PRIMARY Participates in primary metric calculation.
SECONDARY Participates in secondary metric calculations.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isPrimary()
boolean	isSecondary()
static ResultRole	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResultRole[]	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

PRIMARY

public static final ResultRole PRIMARY

Participates in primary metric calculation.

SECONDARY

public static final ResultRole SECONDARY

Participates in secondary metric calculations.

OMITTED

public static final ResultRole OMITTED

Does not participate in any metric, garbage result.

Method Detail

values

public static ResultRole[] 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 (ResultRole c : ResultRole.values())
    System.out.println(c);

Returns:

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

valueOf

public static ResultRole 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

isPrimary

public boolean isPrimary()

isSecondary

public boolean isSecondary()