Package org.openjdk.jmh.results
Enum ResultRole
- java.lang.Object
-
- java.lang.Enum<ResultRole>
-
- org.openjdk.jmh.results.ResultRole
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<ResultRole>
public enum ResultRole extends java.lang.Enum<ResultRole>
-
-
Enum Constant Summary
Enum Constants Enum Constant Description OMITTED
Does not participate in any metric, garbage result.PRIMARY
Participates in primary metric calculation.SECONDARY
Participates in secondary metric calculations.SECONDARY_DERIVATIVE
Same asSECONDARY
, but always recomputed.
-
Constructor Summary
Constructors Modifier Constructor Description private
ResultRole()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isDerivative()
boolean
isPrimary()
boolean
isSecondary()
static ResultRole
valueOf(java.lang.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.
-
-
-
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.
-
SECONDARY_DERIVATIVE
public static final ResultRole SECONDARY_DERIVATIVE
Same asSECONDARY
, but always recomputed.
-
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(java.lang.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:
java.lang.IllegalArgumentException
- if this enum type has no constant with the specified namejava.lang.NullPointerException
- if the argument is null
-
isPrimary
public boolean isPrimary()
-
isSecondary
public boolean isSecondary()
-
isDerivative
public boolean isDerivative()
-
-