Package dev.dokimos.core.comparison

Enum Class ComparisonStatus

java.lang.Object

java.lang.Enum<ComparisonStatus>

dev.dokimos.core.comparison.ComparisonStatus

All Implemented Interfaces:

Serializable, Comparable<ComparisonStatus>, Constable

public enum ComparisonStatus
extends Enum<ComparisonStatus>

Classification of how a metric or item changed between a baseline and a candidate.

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
ADDED	The item exists only in the candidate.
IMPROVED	The candidate is meaningfully and significantly better than the baseline.
REGRESSED	The candidate is meaningfully and significantly worse than the baseline.
REMOVED	The item exists only in the baseline.
UNCHANGED	No meaningful or significant change.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IMPROVED

public static final ComparisonStatus IMPROVED

The candidate is meaningfully and significantly better than the baseline.

REGRESSED

public static final ComparisonStatus REGRESSED

The candidate is meaningfully and significantly worse than the baseline.

UNCHANGED

public static final ComparisonStatus UNCHANGED

No meaningful or significant change.

ADDED

public static final ComparisonStatus ADDED

The item exists only in the candidate.

REMOVED

public static final ComparisonStatus REMOVED

The item exists only in the baseline.

Method Details

values

public static ComparisonStatus[] 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 ComparisonStatus 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