Class SuppressionFilter
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- com.puppycrawl.tools.checkstyle.filters.SuppressionFilter
-
- All Implemented Interfaces:
Configurable
,Contextualizable
,ExternalResourceHolder
,Filter
public class SuppressionFilter extends AutomaticBean implements Filter, ExternalResourceHolder
This filter accepts AuditEvents according to file, check, line, and column, as specified in a suppression file.
-
-
Constructor Summary
Constructors Constructor Description SuppressionFilter()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
accept(AuditEvent event)
Determines whether or not a filtered AuditEvent is accepted.boolean
equals(java.lang.Object obj)
protected void
finishLocalSetup()
Provides a hook to finish the part of this component's setup that was not handled by the bean introspection.java.util.Set<java.lang.String>
getExternalResourceLocations()
Returns a set of external configuration resource locations which are used by the module.int
hashCode()
void
setFile(java.lang.String fileName)
Sets name of the supression file.void
setOptional(boolean optional)
Sets whether config file existence is optional.private static boolean
suppressionSourceExists(java.lang.String fileName)
Checks if suppression source with given fileName exists.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
-
-
-
Field Detail
-
file
private java.lang.String file
Filename of supression file.
-
optional
private boolean optional
Tells whether config file existence is optional.
-
filters
private FilterSet filters
Set of individual suppresses.
-
-
Method Detail
-
setFile
public void setFile(java.lang.String fileName)
Sets name of the supression file.- Parameters:
fileName
- name of the suppressions file.
-
setOptional
public void setOptional(boolean optional)
Sets whether config file existence is optional.- Parameters:
optional
- tells if config file existence is optional.
-
accept
public boolean accept(AuditEvent event)
Description copied from interface:Filter
Determines whether or not a filtered AuditEvent is accepted.
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
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.
- Overrides:
finishLocalSetup
in classAutomaticBean
- Throws:
CheckstyleException
- if there is a configuration error.
-
getExternalResourceLocations
public java.util.Set<java.lang.String> getExternalResourceLocations()
Description copied from interface:ExternalResourceHolder
Returns a set of external configuration resource locations which are used by the module. ATTENTION! If 'getExternalResourceLocations()' return null, there will beNullPointerException
inChecker
. Such behaviour will signal that your module (check or filter) is designed incorrectly. It make sense to return an empty set from 'getExternalResourceLocations()' only for composite modules likeTreeWalker
.- Specified by:
getExternalResourceLocations
in interfaceExternalResourceHolder
- Returns:
- a set of external configuration resource locations which are used by the module.
-
suppressionSourceExists
private static boolean suppressionSourceExists(java.lang.String fileName)
Checks if suppression source with given fileName exists.- Parameters:
fileName
- name of the suppressions file.- Returns:
- true if suppression file exists, otherwise false
-
-