Package com.puppycrawl.tools.checkstyle.filters

Class SuppressionCommentFilter

java.lang.Object
com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter
All Implemented Interfaces:
Configurable, Contextualizable, TreeWalkerFilter
public class SuppressionCommentFilter extends AbstractAutomaticBean implements TreeWalkerFilter
Filter SuppressionCommentFilter uses pairs of comments to suppress audit events.

Rationale: Sometimes there are legitimate reasons for violating a check. When this is a matter of the code in question and not personal preference, the best place to override the policy is in the code itself. Semi-structured comments can be associated with the check. This is sometimes superior to a separate suppressions file, which must be kept up-to-date as the source file is edited.

Note that the suppression comment should be put before the violation. You can use more than one suppression comment each on separate line.

Attention: This filter may only be specified within the TreeWalker module (<module name="TreeWalker"/>) and only applies to checks which are also defined within this module. To filter non-TreeWalker checks like RegexpSingleline, a SuppressWithPlainTextCommentFilter or similar filter must be used.

offCommentFormat and onCommentFormat must have equal paren counts.

SuppressionCommentFilter can suppress Checks that have Treewalker as parent module.

  • Property checkC - Control whether to check C style comments (/* ... */). Type is boolean. Default value is true.
  • Property checkCPP - Control whether to check C++ style comments (//). Type is boolean. Default value is true.
  • Property checkFormat - Specify check pattern to suppress. Type is java.util.regex.Pattern. Default value is ".*".
  • Property idFormat - Specify check ID pattern to suppress. Type is java.util.regex.Pattern. Default value is null.
  • Property messageFormat - Specify message pattern to suppress. Type is java.util.regex.Pattern. Default value is null.
  • Property offCommentFormat - Specify comment pattern to trigger filter to begin suppression. Type is java.util.regex.Pattern. Default value is "CHECKSTYLE:OFF".
  • Property onCommentFormat - Specify comment pattern to trigger filter to end suppression. Type is java.util.regex.Pattern. Default value is "CHECKSTYLE:ON".

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Since:
3.5

  • Field Details

  • Constructor Details

  • Method Details

    • setOffCommentFormat

      public final void setOffCommentFormat(Pattern pattern)
      Setter to specify comment pattern to trigger filter to begin suppression.
      Parameters:
      pattern - a pattern.
      Since:
      3.5

    • setOnCommentFormat

      public final void setOnCommentFormat(Pattern pattern)
      Setter to specify comment pattern to trigger filter to end suppression.
      Parameters:
      pattern - a pattern.
      Since:
      3.5

    • getFileContents

      private FileContents getFileContents()
      Returns FileContents for this filter.
      Returns:
      the FileContents for this filter.

    • setFileContents

      private void setFileContents(FileContents fileContents)
      Set the FileContents for this filter.
      Parameters:
      fileContents - the FileContents for this filter.

    • setCheckFormat

      public final void setCheckFormat(String format)
      Setter to specify check pattern to suppress.
      Parameters:
      format - a String value
      Since:
      3.5

    • setMessageFormat

      public void setMessageFormat(String format)
      Setter to specify message pattern to suppress.
      Parameters:
      format - a String value
      Since:
      3.5

    • setIdFormat

      public void setIdFormat(String format)
      Setter to specify check ID pattern to suppress.
      Parameters:
      format - a String value
      Since:
      8.24

    • setCheckCPP

      public void setCheckCPP(boolean checkCpp)
      Setter to control whether to check C++ style comments (//).
      Parameters:
      checkCpp - true if C++ comments are checked.
      Since:
      3.5

    • setCheckC

      public void setCheckC(boolean checkC)
      Setter to control whether to check C style comments (/* ... */).
      Parameters:
      checkC - true if C comments are checked.
      Since:
      3.5

    • finishLocalSetup

      protected void finishLocalSetup()
      Description copied from class: AbstractAutomaticBean
      Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.

      The default implementation does nothing.

      Specified by:
      finishLocalSetup in class AbstractAutomaticBean

    • accept

      public boolean accept(TreeWalkerAuditEvent event)
      Description copied from interface: TreeWalkerFilter
      Determines whether or not a filtered TreeWalkerAuditEvent is accepted.
      Specified by:
      accept in interface TreeWalkerFilter
      Parameters:
      event - the TreeWalkerAuditEvent to filter.
      Returns:
      true if the event is accepted.

    • findNearestMatch

      private SuppressionCommentFilter.Tag findNearestMatch(TreeWalkerAuditEvent event)
      Finds the nearest comment text tag that matches an audit event. The nearest tag is before the line and column of the event.
      Parameters:
      event - the TreeWalkerAuditEvent to match.
      Returns:
      The Tag nearest event.

    • tagSuppressions

      private void tagSuppressions()
      Collects all the suppression tags for all comments into a list and sorts the list.

    • tagSuppressions

      private void tagSuppressions(Collection<TextBlock> comments)
      Appends the suppressions in a collection of comments to the full set of suppression tags.
      Parameters:
      comments - the set of comments.

    • tagCommentLine

      private void tagCommentLine(String text, int line, int column)
      Tags a string if it matches the format for turning checkstyle reporting on or the format for turning reporting off.
      Parameters:
      text - the string to tag.
      line - the line number of text.
      column - the column number of text.

    • addTag

      private void addTag(String text, int line, int column, SuppressionCommentFilter.TagType reportingOn)
      Adds a Tag to the list of all tags.
      Parameters:
      text - the text of the tag.
      line - the line number of the tag.
      column - the column number of the tag.
      reportingOn - true if the tag turns checkstyle reporting on.