com.puppycrawl.tools.checkstyle.filters

Class SuppressWithNearbyCommentFilter

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter

All Implemented Interfaces:

Configurable, Contextualizable, TreeWalkerFilter

public class SuppressWithNearbyCommentFilter
extends AutomaticBean
implements TreeWalkerFilter

A filter that uses nearby comments to suppress audit events.

This check is philosophically similar to SuppressionCommentFilter. Unlike SuppressionCommentFilter, this filter does not require pairs of comments. This check may be used to suppress warnings in the current line:

    offendingLine(for, whatever, reason); // SUPPRESS ParameterNumberCheck
 

or it may be configured to span multiple lines, either forward:

    // PERMIT MultipleVariableDeclarations NEXT 3 LINES
    double x1 = 1.0, y1 = 0.0, z1 = 0.0;
    double x2 = 0.0, y2 = 1.0, z2 = 0.0;
    double x3 = 0.0, y3 = 0.0, z3 = 1.0;
 

or reverse:

   try {
     thirdPartyLibrary.method();
   } catch (RuntimeException ex) {
     // ALLOW ILLEGAL CATCH BECAUSE third party API wraps everything
     // in RuntimeExceptions.
     ...
   }
 

See SuppressionCommentFilter for usage notes.

Author:

Mick Killianey

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SuppressWithNearbyCommentFilter.Tag A Tag holds a suppression comment and its location.

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Constructor Summary

Constructors

Constructor and Description
SuppressWithNearbyCommentFilter()

Method Summary

Modifier and Type	Method and Description
boolean	accept(TreeWalkerAuditEvent event) Determines whether or not a filtered TreeWalkerAuditEvent is accepted.
protected void	finishLocalSetup() Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.
void	setCheckC(boolean checkC) Set whether to look in C comments.
void	setCheckCPP(boolean checkCpp) Set whether to look in C++ comments.
void	setCheckFormat(String format) Set the format for a check.
void	setCommentFormat(Pattern pattern) Set the format for a comment that turns off reporting.
void	setFileContents(FileContents fileContents) Set the FileContents for this filter.
void	setInfluenceFormat(String format) Set the format for the influence of this check.
void	setMessageFormat(String format) Set the format for a message.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Constructor Detail

SuppressWithNearbyCommentFilter

public SuppressWithNearbyCommentFilter()

Method Detail

setCommentFormat

public final void setCommentFormat(Pattern pattern)

Set the format for a comment that turns off reporting.

Parameters:

pattern - a pattern.

setFileContents

public void setFileContents(FileContents fileContents)

Set the FileContents for this filter.

Parameters:

fileContents - the FileContents for this filter.

setCheckFormat

public final void setCheckFormat(String format)

Set the format for a check.

Parameters:

format - a String value

setMessageFormat

public void setMessageFormat(String format)

Set the format for a message.

Parameters:

format - a String value

setInfluenceFormat

public final void setInfluenceFormat(String format)

Set the format for the influence of this check.

Parameters:

format - a String value

setCheckCPP

public void setCheckCPP(boolean checkCpp)

Set whether to look in C++ comments.

Parameters:

checkCpp - true if C++ comments are checked.

setCheckC

public void setCheckC(boolean checkC)

Set whether to look in C comments.

Parameters:

checkC - true if C comments are checked.

finishLocalSetup

protected void finishLocalSetup()
                         throws CheckstyleException

Description copied from class: AutomaticBean

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 AutomaticBean

Throws:

CheckstyleException - if there is a configuration error.

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.