Package com.google.gerrit.extensions.common

Class SubmitRequirementExpressionInfo

java.lang.Object

com.google.gerrit.extensions.common.SubmitRequirementExpressionInfo

public class SubmitRequirementExpressionInfo
extends Object

Result of evaluating a single submit requirement expression. This API entity is populated from

invalid reference

com.google.gerrit.entities.SubmitRequirementExpressionResult

.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SubmitRequirementExpressionInfo.Status	Values in this enum should match with values in invalid reference com.google.gerrit.entities.SubmitRequirementExpressionResult.Status .

Field Summary

Fields

Modifier and Type	Field	Description
Map<String,String>	atomExplanations	Map of leaf predicates to their explanations.
String	errorMessage	Optional error message.
String	expression	Submit requirement expression as a String.
List<String>	failingAtoms	A list of all atoms that are failing, for example query "branch:refs/heads/foo and project:bar" has two atoms: ["branch:refs/heads/foo", "project:bar"].
boolean	fulfilled	A boolean indicating if the expression is fulfilled on a change.
List<String>	passingAtoms	A list of all atoms that are passing, for example query "branch:refs/heads/foo and project:bar" has two atoms: ["branch:refs/heads/foo", "project:bar"].
SubmitRequirementExpressionInfo.Status	status	A status indicating if the expression is fulfilled, non-fulfilled or not evaluated.

Constructor Summary

Constructors

Constructor	Description
SubmitRequirementExpressionInfo()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

expression

public String expression

Submit requirement expression as a String.

fulfilled

public boolean fulfilled

A boolean indicating if the expression is fulfilled on a change.

status

public SubmitRequirementExpressionInfo.Status status

A status indicating if the expression is fulfilled, non-fulfilled or not evaluated.

passingAtoms

public List<String> passingAtoms

A list of all atoms that are passing, for example query "branch:refs/heads/foo and project:bar" has two atoms: ["branch:refs/heads/foo", "project:bar"].

failingAtoms

public List<String> failingAtoms

A list of all atoms that are failing, for example query "branch:refs/heads/foo and project:bar" has two atoms: ["branch:refs/heads/foo", "project:bar"].

atomExplanations

public Map<String,String> atomExplanations

Map of leaf predicates to their explanations.

This is used to provide more information about complex atoms, which may otherwise be opaque and hard to debug.

This will only be populated/implemented for some atoms.

errorMessage

public String errorMessage

Optional error message. Contains an explanation of why the submit requirement expression failed during its evaluation.

Constructor Details

SubmitRequirementExpressionInfo

public SubmitRequirementExpressionInfo()

Method Details

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object