net.degreedays.api.regression

Enum RegressionTag

java.lang.Object

java.lang.Enum<RegressionTag>

net.degreedays.api.regression.RegressionTag

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RegressionTag>

public enum RegressionTag
extends java.lang.Enum<RegressionTag>

An enum of tags that the API adds to Regression objects to indicate why it included them in a RegressionResponse.

Since:

1.4

Enum Constant Summary

Enum Constants

Enum Constant and Description
IN_SHORTLIST_RANGE Indicates a regression that was explicitly specified in the request, and that has strong enough statistics to appear in the SHORTLIST even though it wasn't auto-selected to be in the shortlist (if it was it would have the SHORTLIST tag instead).
NOTABLE_OTHER Indicates a regression that didn't make the SHORTLIST, but was considered notable.
REQUESTED Indicates a regression that was explicitly specified in the request as one that should be returned.
SHORTLIST Indicates a regression that was automatically selected by the API as a shortlist regression – one that looks likely to describe the usage data better than the others tested.

Method Summary

Modifier and Type	Method and Description
static RegressionTag	fromString(java.lang.String string) Returns the non-null RegressionTag with the specified string (returned by its toString() method).
java.lang.String	toString() Returns a non-null, non-empty string representation of this enum constant in the format used to specify a RegressionTag in the response XML ("Shortlist", "NotableOther", "Requested", or "InShortlistRange").
static RegressionTag	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RegressionTag[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SHORTLIST

public static final RegressionTag SHORTLIST

Indicates a regression that was automatically selected by the API as a shortlist regression – one that looks likely to describe the usage data better than the others tested.

NOTABLE_OTHER

public static final RegressionTag NOTABLE_OTHER

Indicates a regression that didn't make the SHORTLIST, but was considered notable. This might, for example, apply to the best CDD-only regression for a set of data that correlates better with HDD than CDD, or to a regression with shortlist-worthy stats but unexpected negative coefficients.

REQUESTED

public static final RegressionTag REQUESTED

Indicates a regression that was explicitly specified in the request as one that should be returned.

See Also:

RegressionTestPlan.Builder.setRequestedRegressionSpecs(RegressionSpec...)

IN_SHORTLIST_RANGE

public static final RegressionTag IN_SHORTLIST_RANGE

Indicates a regression that was explicitly specified in the request, and that has strong enough statistics to appear in the SHORTLIST even though it wasn't auto-selected to be in the shortlist (if it was it would have the SHORTLIST tag instead). It is possible for none of the REQUESTED regressions to have this tag if none of them have statistics as good as the auto-selected SHORTLIST regressions.

See Also:

RegressionTestPlan.Builder.setRequestedRegressionSpecs(RegressionSpec...)

Method Detail

values

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

Returns:

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

valueOf

public static RegressionTag 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 name

java.lang.NullPointerException - if the argument is null

toString

public java.lang.String toString()

Returns a non-null, non-empty string representation of this enum constant in the format used to specify a RegressionTag in the response XML ("Shortlist", "NotableOther", "Requested", or "InShortlistRange").

Overrides:

toString in class java.lang.Enum<RegressionTag>

fromString

public static RegressionTag fromString(java.lang.String string)
                                throws java.lang.IllegalArgumentException

Returns the non-null RegressionTag with the specified string (returned by its toString() method).

Throws:

java.lang.NullPointerException - if string is null.

java.lang.IllegalArgumentException - if string is not one of "Shortlist", "NotableOther", "Requested", or "InShortlistRange".