com.google.gerrit.common.data

Enum LabelFunction

java.lang.Object

java.lang.Enum<LabelFunction>

com.google.gerrit.common.data.LabelFunction

All Implemented Interfaces:

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

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

Functions for determining submittability based on label votes.

Only describes built-in label functions. Admins can extend the logic arbitrarily using Prolog rules, in which case the choice of function in the project config is ignored.

Function semantics are documented in config-labels.txt, and actual behavior is implemented both in Prolog in gerrit_common.pl and in the check(com.google.gerrit.common.data.LabelType, java.lang.Iterable<com.google.gerrit.reviewdb.client.PatchSetApproval>) method.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY_WITH_BLOCK
MAX_NO_BLOCK
MAX_WITH_BLOCK
NO_BLOCK
NO_OP
PATCH_SET_LOCK

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.Map<java.lang.String,LabelFunction>	ALL

Method Summary

Modifier and Type	Method and Description
SubmitRecord.Label	check(LabelType labelType, java.lang.Iterable<PatchSetApproval> approvals)
java.lang.String	getFunctionName() The function name as defined in documentation and project.config.
boolean	isBlock() Whether the label is a "block" label, meaning a minimum vote will prevent submission.
boolean	isMaxValueRequired() Whether the label requires a vote with the maximum value to allow submission.
boolean	isRequired() Whether the label is a mandatory label, meaning absence of votes will prevent submission.
static java.util.Optional<LabelFunction>	parse(java.lang.String str)
static LabelFunction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LabelFunction[]	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

ANY_WITH_BLOCK

public static final LabelFunction ANY_WITH_BLOCK

MAX_WITH_BLOCK

public static final LabelFunction MAX_WITH_BLOCK

MAX_NO_BLOCK

public static final LabelFunction MAX_NO_BLOCK

NO_BLOCK

public static final LabelFunction NO_BLOCK

NO_OP

public static final LabelFunction NO_OP

PATCH_SET_LOCK

public static final LabelFunction PATCH_SET_LOCK

Field Detail

ALL

public static final java.util.Map<java.lang.String,LabelFunction> ALL

Method Detail

values

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

Returns:

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

valueOf

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

parse

public static java.util.Optional<LabelFunction> parse(java.lang.String str)

getFunctionName

public java.lang.String getFunctionName()

The function name as defined in documentation and project.config.

isBlock

public boolean isBlock()

Whether the label is a "block" label, meaning a minimum vote will prevent submission.

isRequired

public boolean isRequired()

Whether the label is a mandatory label, meaning absence of votes will prevent submission.

isMaxValueRequired

public boolean isMaxValueRequired()

Whether the label requires a vote with the maximum value to allow submission.

check

public SubmitRecord.Label check(LabelType labelType,
                                java.lang.Iterable<PatchSetApproval> approvals)