SuppressWarningsFilter (checkstyle 10.21.0 API)

java.lang.Object
- com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
- - com.puppycrawl.tools.checkstyle.filters.SuppressWarningsFilter

All Implemented Interfaces:

Configurable, Contextualizable, Filter
```
public class SuppressWarningsFilter
extends AbstractAutomaticBean
implements Filter
```
Filter SuppressWarningsFilter uses annotation @SuppressWarnings to suppress audit events.

Rationale: Same as for SuppressionCommentFilter. In the contrary to it here, comments are not used comments but the builtin syntax of @SuppressWarnings. This can be perceived as a more elegant solution than using comments. Also, this approach maybe supported by various IDE.

Usage: This filter only works in conjunction with a SuppressWarningsHolder, since that check finds the annotations in the Java files and makes them available for the filter. Because of that, a configuration that includes this filter must also include SuppressWarningsHolder as a child module of the TreeWalker. Name of check in annotation is case-insensitive and should be written with any dotted prefix or "Check" suffix removed.

SuppressWarningsFilter can suppress Checks that have Treewalker or Checker as parent module.

Parent is com.puppycrawl.tools.checkstyle.Checker

Since:

5.7

Nested Class Summary
- Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
  AbstractAutomaticBean.OutputStreamOptions

Constructor Summary

Constructors
Constructor Description

SuppressWarningsFilter()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`accept(AuditEvent event)`	Determines whether or not a filtered AuditEvent 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.

Methods inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
configure, contextualize, getConfiguration, setupChild

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

- Constructor Detail
  - SuppressWarningsFilter
```
public SuppressWarningsFilter()
```
- Method Detail
  - 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(AuditEvent event)
```
    Description copied from interface: Filter
    
    Determines whether or not a filtered AuditEvent is accepted.
    
    Specified by:
    
    accept in interface Filter
    
    Parameters:
    
    event - the AuditEvent to filter.
    
    Returns:
    
    true if the event is accepted.