CommentCountValidator (Gerrit Review Plugin API Documentation)

java.lang.Object

com.google.gerrit.server.git.validators.CommentCountValidator

All Implemented Interfaces:: CommentValidator

public class CommentCountValidator extends Object implements CommentValidator

Limits number of comments to prevent space/time complexity issues.

Method Summary

Modifier and Type

Method

Description

com.google.common.collect.ImmutableList<CommentValidationFailure>

validateComments(CommentValidationContext ctx, com.google.common.collect.ImmutableList<CommentForValidation> comments)

Validate the specified comments.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- validateComments
  
  public com.google.common.collect.ImmutableList<CommentValidationFailure> validateComments(CommentValidationContext ctx, com.google.common.collect.ImmutableList<CommentForValidation> comments)
  
  Description copied from interface: CommentValidator
  
  Validate the specified comments. This method will be called once with the comments argument containing all new comments that need to be validated and (if applicable) the new change message. This allows validators to statelessly count the new comments. Note that after this one call the method may be called again one or more times for texts that are not comments, but similar in nature.
  NOTE: Autogenerated change messages are not subject to validation.
  
  Specified by:
  
  validateComments in interface CommentValidator
  
  Returns:
  
  An empty list if all comments are valid, or else a list of validation failures.