com.google.gerrit.plugins.checks.api

Enum CheckState

java.lang.Object

java.lang.Enum<CheckState>

com.google.gerrit.plugins.checks.api.CheckState

All Implemented Interfaces:

Serializable, Comparable<CheckState>

public enum CheckState
extends Enum<CheckState>

State of a single check on a change.

This state applies to a single check; for the aggregated state associated with a change, see CombinedCheckState.

Ordering is not significant in this class, but for consistency's sake the ordering matches CombinedCheckState where applicable.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAILED The check terminated and failed.
NOT_RELEVANT The check is not relevant for the change.
NOT_STARTED The check is relevant to the change, but the checker has not started work.
RUNNING The checker is currently running the check.
SCHEDULED The checker has acknowledged that it has work to do on the change, and will start work in the future.
SUCCESSFUL The check terminated and succeeded.

Method Summary

Modifier and Type	Method and Description
boolean	isInProgress() Returns whether the state represents an in-progress state.
static CheckState	valueOf(String name) Returns the enum constant of this type with the specified name.
static CheckState[]	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

FAILED

public static final CheckState FAILED

The check terminated and failed.

Failure may include the following cases:

• The check completed normally and found a problem with the code in the change.
• The check failed to start.
• The check started, but failed for some reason not directly related to the code, such as a setup failure in the checker.

NOT_STARTED

public static final CheckState NOT_STARTED

The check is relevant to the change, but the checker has not started work.

SCHEDULED

public static final CheckState SCHEDULED

The checker has acknowledged that it has work to do on the change, and will start work in the future.

RUNNING

public static final CheckState RUNNING

The checker is currently running the check.

SUCCESSFUL

public static final CheckState SUCCESSFUL

The check terminated and succeeded.

NOT_RELEVANT

public static final CheckState NOT_RELEVANT

The check is not relevant for the change.

Method Detail

values

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

Returns:

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

valueOf

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

isInProgress

public boolean isInProgress()

Returns whether the state represents an in-progress state.

A check is in progress if the checker is relevant to the change, and the checker system has not yet completed the check.

Returns:

whether the state represents an in-progress state.