Package com.google.gerrit.entities

Class SubmitRequirementExpressionResult

java.lang.Object

com.google.gerrit.entities.SubmitRequirementExpressionResult

public abstract class SubmitRequirementExpressionResult
extends Object

Result of evaluating a submit requirement expression on a given Change.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubmitRequirementExpressionResult.Builder
static class	SubmitRequirementExpressionResult.PredicateResult	Entity detailing the result of evaluating a predicate.
static enum	SubmitRequirementExpressionResult.Status

Constructor Summary

Constructors

Constructor	Description
SubmitRequirementExpressionResult()

Method Summary

Modifier and Type	Method	Description
abstract Optional<com.google.common.collect.ImmutableMap<String,String>>	atomExplanations()	Map of leaf predicates to their explanations.
static SubmitRequirementExpressionResult	create(SubmitRequirementExpression expression, SubmitRequirementExpressionResult.PredicateResult predicateResult)
static SubmitRequirementExpressionResult	create(SubmitRequirementExpression expression, SubmitRequirementExpressionResult.Status status, com.google.common.collect.ImmutableList<String> passingAtoms, com.google.common.collect.ImmutableList<String> failingAtoms)
static SubmitRequirementExpressionResult	create(SubmitRequirementExpression expression, SubmitRequirementExpressionResult.Status status, com.google.common.collect.ImmutableList<String> passingAtoms, com.google.common.collect.ImmutableList<String> failingAtoms, Optional<com.google.common.collect.ImmutableMap<String,String>> atomExplanations)
static SubmitRequirementExpressionResult	create(SubmitRequirementExpression expression, SubmitRequirementExpressionResult.Status status, com.google.common.collect.ImmutableList<String> passingAtoms, com.google.common.collect.ImmutableList<String> failingAtoms, Optional<com.google.common.collect.ImmutableMap<String,String>> atomExplanations, Optional<String> errorMessage)
static SubmitRequirementExpressionResult	error(SubmitRequirementExpression expression, String errorMessage)
abstract Optional<String>	errorMessage()	Optional error message.
abstract SubmitRequirementExpression	expression()	Submit requirement expression for which this result is evaluated.
abstract com.google.common.collect.ImmutableList<String>	failingAtoms()	List of leaf predicates that are not fulfilled.
static SubmitRequirementExpressionResult	notEvaluated(SubmitRequirementExpression expr)
abstract com.google.common.collect.ImmutableList<String>	passingAtoms()	List leaf predicates that are fulfilled, for example the expression
abstract SubmitRequirementExpressionResult.Status	status()	Status of evaluation.
abstract SubmitRequirementExpressionResult.Builder	toBuilder()
static com.google.gson.TypeAdapter<SubmitRequirementExpressionResult>	typeAdapter(com.google.gson.Gson gson)

Methods inherited from class java.lang.Object

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

Constructor Details

SubmitRequirementExpressionResult

public SubmitRequirementExpressionResult()

Method Details

expression

public abstract SubmitRequirementExpression expression()

Submit requirement expression for which this result is evaluated.

status

public abstract SubmitRequirementExpressionResult.Status status()

Status of evaluation.

errorMessage

public abstract Optional<String> errorMessage()

Optional error message. Populated if the evaluator fails to evaluate the expression for a certain change.

passingAtoms

public abstract com.google.common.collect.ImmutableList<String> passingAtoms()

List leaf predicates that are fulfilled, for example the expression

label:Code-Review=+2 and branch:refs/heads/master

has two leaf predicates:

• label:Code-Review=+2
• branch:refs/heads/master

This method will return the leaf predicates that were fulfilled, for example if only the first predicate was fulfilled, the returned list will be equal to ["label:Code-Review=+2"].

failingAtoms

public abstract com.google.common.collect.ImmutableList<String> failingAtoms()

List of leaf predicates that are not fulfilled. See passingAtoms() for more details.

atomExplanations

public abstract Optional<com.google.common.collect.ImmutableMap<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.

create

public static SubmitRequirementExpressionResult create(SubmitRequirementExpression expression,
 SubmitRequirementExpressionResult.PredicateResult predicateResult)

create

public static SubmitRequirementExpressionResult create(SubmitRequirementExpression expression,
 SubmitRequirementExpressionResult.Status status,
 com.google.common.collect.ImmutableList<String> passingAtoms,
 com.google.common.collect.ImmutableList<String> failingAtoms)

create

public static SubmitRequirementExpressionResult create(SubmitRequirementExpression expression,
 SubmitRequirementExpressionResult.Status status,
 com.google.common.collect.ImmutableList<String> passingAtoms,
 com.google.common.collect.ImmutableList<String> failingAtoms,
 Optional<com.google.common.collect.ImmutableMap<String,String>> atomExplanations)

create

public static SubmitRequirementExpressionResult create(SubmitRequirementExpression expression,
 SubmitRequirementExpressionResult.Status status,
 com.google.common.collect.ImmutableList<String> passingAtoms,
 com.google.common.collect.ImmutableList<String> failingAtoms,
 Optional<com.google.common.collect.ImmutableMap<String,String>> atomExplanations,
 Optional<String> errorMessage)

error

public static SubmitRequirementExpressionResult error(SubmitRequirementExpression expression,
 String errorMessage)

notEvaluated

public static SubmitRequirementExpressionResult notEvaluated(SubmitRequirementExpression expr)

typeAdapter

public static com.google.gson.TypeAdapter<SubmitRequirementExpressionResult> typeAdapter(com.google.gson.Gson gson)

toBuilder

public abstract SubmitRequirementExpressionResult.Builder toBuilder()