Package com.google.gerrit.entities

Enum Class LabelFunction

java.lang.Object
java.lang.Enum<LabelFunction>
com.google.gerrit.entities.LabelFunction
All Implemented Interfaces:
Serializable, Comparable<LabelFunction>, java.lang.constant.Constable
public enum LabelFunction extends 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.entities.LabelType, java.lang.Iterable<com.google.gerrit.entities.PatchSetApproval>) method.

  • Enum Constant Details

  • Field Details

  • Method Details

    • values

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

    • parse

      public static Optional<LabelFunction> parse(String str)

    • getFunctionName

      public 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, Iterable<PatchSetApproval> approvals)