Package com.google.gerrit.server.git.validators

Class CommitValidationInfo

java.lang.Object

com.google.gerrit.server.git.validators.CommitValidationInfo

public abstract class CommitValidationInfo
extends Object

Result of invoking a CommitValidationListener if the commit passed the validator.

Note, if a commit is rejected by a CommitValidationListener it throws a CommitValidationException and no CommitValidationInfo is returned. Hence CommitValidationInfo doesn't cover rejections.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CommitValidationInfo.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final com.google.common.collect.ImmutableMap<String,String>	NO_METADATA	Empty metadata map.

Constructor Summary

Constructors

Constructor	Description
CommitValidationInfo()

Method Summary

Modifier and Type	Method	Description
abstract com.google.common.collect.ImmutableMap<String,String>	metadata()	Metadata about the commit validation that has been performed, for example the version ID of the configuration that was used for the commit validation or the SHA1 from which the configuration that was used for the commit validation was read.
static CommitValidationInfo	notApplicable(com.google.common.collect.ImmutableMap<String,String> metadata)
static CommitValidationInfo	passed(com.google.common.collect.ImmutableMap<String,String> metadata, com.google.common.collect.ImmutableList<CommitValidationMessage> validationMessages)
static CommitValidationInfo	skippedByUser(com.google.common.collect.ImmutableMap<String,String> metadata)
abstract CommitValidationInfo.Status	status()	Status of the commit validation run.
abstract com.google.common.collect.ImmutableList<CommitValidationMessage>	validationMessages()	Validation messages collected during the commit validation run.

Methods inherited from class java.lang.Object

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

Field Details

NO_METADATA

public static final com.google.common.collect.ImmutableMap<String,String> NO_METADATA

Empty metadata map.

Constructor Details

CommitValidationInfo

public CommitValidationInfo()

Method Details

status

public abstract CommitValidationInfo.Status status()

Status of the commit validation run.

metadata

public abstract com.google.common.collect.ImmutableMap<String,String> metadata()

Metadata about the commit validation that has been performed, for example the version ID of the configuration that was used for the commit validation or the SHA1 from which the configuration that was used for the commit validation was read.

validationMessages

public abstract com.google.common.collect.ImmutableList<CommitValidationMessage> validationMessages()

Validation messages collected during the commit validation run.

passed

public static CommitValidationInfo passed(com.google.common.collect.ImmutableMap<String,String> metadata,
 com.google.common.collect.ImmutableList<CommitValidationMessage> validationMessages)

notApplicable

public static CommitValidationInfo notApplicable(com.google.common.collect.ImmutableMap<String,String> metadata)

skippedByUser

public static CommitValidationInfo skippedByUser(com.google.common.collect.ImmutableMap<String,String> metadata)