Class SuppressWithNearbyCommentFilter.Tag
java.lang.Object
com.puppycrawl.tools.checkstyle.filters.SuppressWithNearbyCommentFilter.Tag
- Enclosing class:
- SuppressWithNearbyCommentFilter
A Tag holds a suppression comment and its location.
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final int
The first line where warnings may be suppressed.private final int
The last line where warnings may be suppressed.private final Pattern
The parsed check regexp, expanded for the text of this tag.private final Pattern
The parsed check ID regexp, expanded for the text of this tag.private final Pattern
The parsed message regexp, expanded for the text of this tag.private final String
The text of the tag. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Tag
(String text, int line, SuppressWithNearbyCommentFilter filter) Constructs a tag. -
Method Summary
Modifier and TypeMethodDescriptionboolean
int
hashCode()
private boolean
isCheckMatch
(TreeWalkerAuditEvent event) Checks whetherTreeWalkerAuditEvent
source name matches the check format.private boolean
isIdMatch
(TreeWalkerAuditEvent event) Checks whether theTreeWalkerAuditEvent
module ID matches the ID format.private boolean
Checks whether theTreeWalkerAuditEvent
is in the scope of the suppression.boolean
isMatch
(TreeWalkerAuditEvent event) Determines whether the source of an audit event matches the text of this tag.private boolean
Checks whether theTreeWalkerAuditEvent
message matches the message format.private static int
parseInfluence
(String format, String influenceFormat, String text) Gets influence from suppress filter influence format param.toString()
-
Field Details
-
text
The text of the tag. -
firstLine
The first line where warnings may be suppressed. -
lastLine
The last line where warnings may be suppressed. -
tagCheckRegexp
The parsed check regexp, expanded for the text of this tag. -
tagMessageRegexp
The parsed message regexp, expanded for the text of this tag. -
tagIdRegexp
The parsed check ID regexp, expanded for the text of this tag.
-
-
Constructor Details
-
Tag
Constructs a tag.- Parameters:
text
- the text of the suppression.line
- the line number.filter
- theSuppressWithNearbyCommentFilter
with the context- Throws:
IllegalArgumentException
- if unable to parse expanded text.
-
-
Method Details
-
parseInfluence
Gets influence from suppress filter influence format param.- Parameters:
format
- influence format to parseinfluenceFormat
- raw influence formattext
- text of the suppression- Returns:
- parsed influence
- Throws:
IllegalArgumentException
- when unable to parse int in format
-
equals
-
hashCode
-
isMatch
Determines whether the source of an audit event matches the text of this tag.- Parameters:
event
- theTreeWalkerAuditEvent
to check.- Returns:
- true if the source of event matches the text of this tag.
-
isInScopeOfSuppression
Checks whether theTreeWalkerAuditEvent
is in the scope of the suppression.- Parameters:
event
-TreeWalkerAuditEvent
instance.- Returns:
- true if the
TreeWalkerAuditEvent
is in the scope of the suppression.
-
isCheckMatch
Checks whetherTreeWalkerAuditEvent
source name matches the check format.- Parameters:
event
-TreeWalkerAuditEvent
instance.- Returns:
- true if the
TreeWalkerAuditEvent
source name matches the check format.
-
isIdMatch
Checks whether theTreeWalkerAuditEvent
module ID matches the ID format.- Parameters:
event
-TreeWalkerAuditEvent
instance.- Returns:
- true if the
TreeWalkerAuditEvent
module ID matches the ID format.
-
isMessageMatch
Checks whether theTreeWalkerAuditEvent
message matches the message format.- Parameters:
event
-TreeWalkerAuditEvent
instance.- Returns:
- true if the
TreeWalkerAuditEvent
message matches the message format.
-
toString
-