Package com.google.gerrit.entities

Class SubmitRequirementResult

java.lang.Object

com.google.gerrit.entities.SubmitRequirementResult

public abstract class SubmitRequirementResult
extends Object

Result of evaluating a SubmitRequirement on a given Change.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SubmitRequirementResult.Builder
static enum	SubmitRequirementResult.Status

Constructor Summary

Constructors

Constructor	Description
SubmitRequirementResult()

Method Summary

Modifier and Type	Method	Description
abstract Optional<SubmitRequirementExpressionResult>	applicabilityExpressionResult()	Result of evaluating a SubmitRequirement.applicabilityExpression() on a change.
static boolean	assertError(Optional<SubmitRequirementExpressionResult> expressionResult)
static boolean	assertFail(Optional<SubmitRequirementExpressionResult> expressionResult)
static boolean	assertPass(Optional<SubmitRequirementExpressionResult> expressionResult)
static SubmitRequirementResult.Builder	builder()
Optional<String>	errorMessage()
abstract Optional<Boolean>	forced()	Boolean indicating if the "submit requirement" was bypassed during submission, e.g.
boolean	fulfilled()	Returns true if the submit requirement is fulfilled and can allow change submission.
abstract Optional<Boolean>	hidden()	Whether this result should be filtered out when returned from REST API.
boolean	isHidden()
boolean	isLegacy()
abstract Optional<Boolean>	legacy()	Whether this result was created from a legacy SubmitRecord, or by evaluating a SubmitRequirement.
abstract Optional<SubmitRequirementExpressionResult>	overrideExpressionResult()	Result of evaluating a SubmitRequirement.overrideExpression() on a change.
abstract org.eclipse.jgit.lib.ObjectId	patchSetCommitId()	SHA-1 of the patchset commit ID for which the submit requirement was evaluated.
SubmitRequirementResult.Status	status()
abstract SubmitRequirement	submitRequirement()	Submit requirement for which this result is evaluated.
abstract Optional<SubmitRequirementExpressionResult>	submittabilityExpressionResult()	Result of evaluating a SubmitRequirement.submittabilityExpression() on a change.
abstract SubmitRequirementResult.Builder	toBuilder()
static com.google.gson.TypeAdapter<SubmitRequirementResult>	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

SubmitRequirementResult

public SubmitRequirementResult()

Method Details

submitRequirement

public abstract SubmitRequirement submitRequirement()

Submit requirement for which this result is evaluated.

applicabilityExpressionResult

public abstract Optional<SubmitRequirementExpressionResult> applicabilityExpressionResult()

Result of evaluating a SubmitRequirement.applicabilityExpression() on a change.

submittabilityExpressionResult

public abstract Optional<SubmitRequirementExpressionResult> submittabilityExpressionResult()

Result of evaluating a SubmitRequirement.submittabilityExpression() on a change.

Empty if submit requirement does not apply.

overrideExpressionResult

public abstract Optional<SubmitRequirementExpressionResult> overrideExpressionResult()

Result of evaluating a SubmitRequirement.overrideExpression() on a change.

Empty if submit requirement does not apply, or if the submit requirement did not define an override expression.

patchSetCommitId

public abstract org.eclipse.jgit.lib.ObjectId patchSetCommitId()

SHA-1 of the patchset commit ID for which the submit requirement was evaluated.

legacy

public abstract Optional<Boolean> legacy()

Whether this result was created from a legacy SubmitRecord, or by evaluating a SubmitRequirement.

If equals Optional.empty(), we treat the result as non-legacy (false).

isLegacy

public boolean isLegacy()

forced

public abstract Optional<Boolean> forced()

Boolean indicating if the "submit requirement" was bypassed during submission, e.g. by performing a push with the %submit option.

hidden

public abstract Optional<Boolean> hidden()

Whether this result should be filtered out when returned from REST API.

This can be used by OnStoreSubmitRequirementResultModifier. It can override the SubmitRequirementResult status and might want to hide the SR from the API as if it was non-applicable (non-applicable SRs are currently hidden on UI).

isHidden

public boolean isHidden()

errorMessage

public Optional<String> errorMessage()

status

@Memoized
public SubmitRequirementResult.Status status()

fulfilled

@Memoized
public boolean fulfilled()

Returns true if the submit requirement is fulfilled and can allow change submission.

builder

public static SubmitRequirementResult.Builder builder()

toBuilder

public abstract SubmitRequirementResult.Builder toBuilder()

typeAdapter

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

assertPass

public static boolean assertPass(Optional<SubmitRequirementExpressionResult> expressionResult)

assertFail

public static boolean assertFail(Optional<SubmitRequirementExpressionResult> expressionResult)

assertError

public static boolean assertError(Optional<SubmitRequirementExpressionResult> expressionResult)