Package com.puppycrawl.tools.checkstyle.filters

Class SuppressWithPlainTextCommentFilter.Suppression

java.lang.Object

com.puppycrawl.tools.checkstyle.filters.SuppressWithPlainTextCommentFilter.Suppression

Enclosing class:

SuppressWithPlainTextCommentFilter

private static final class SuppressWithPlainTextCommentFilter.Suppression
extends java.lang.Object

The class which represents the suppression.

Field Summary

Fields

Modifier and Type	Field	Description
private int	columnNo	Suppression column number.
private java.util.regex.Pattern	eventIdRegexp	The regexp which is used to match the event ID.
private java.util.regex.Pattern	eventMessageRegexp	The regexp which is used to match the event message.
private java.util.regex.Pattern	eventSourceRegexp	The regexp which is used to match the event source.
private int	lineNo	Suppression line.
private SuppressWithPlainTextCommentFilter.SuppressionType	suppressionType	Suppression type.
private java.lang.String	text	Suppression text.

Constructor Summary

Constructors

Constructor	Description
Suppression(java.lang.String text, int lineNo, int columnNo, SuppressWithPlainTextCommentFilter.SuppressionType suppressionType, SuppressWithPlainTextCommentFilter filter)	Creates new suppression instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object other)	Indicates whether some other object is "equal to" this one.
int	hashCode()
private boolean	isCheckMatch(AuditEvent event)	Checks whether AuditEvent source name matches the check format.
private boolean	isIdMatch(AuditEvent event)	Checks whether the AuditEvent module ID matches the ID format.
private boolean	isInScopeOfSuppression(AuditEvent event)	Checks whether AuditEvent is in the scope of the suppression.
private boolean	isMatch(AuditEvent event)	Checks whether the suppression matches the given AuditEvent.
private boolean	isMessageMatch(AuditEvent event)	Checks whether the AuditEvent message matches the message format.

Methods inherited from class java.lang.Object

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

Field Detail

eventSourceRegexp

private final java.util.regex.Pattern eventSourceRegexp

The regexp which is used to match the event source.

eventMessageRegexp

private final java.util.regex.Pattern eventMessageRegexp

The regexp which is used to match the event message.

eventIdRegexp

private final java.util.regex.Pattern eventIdRegexp

The regexp which is used to match the event ID.

text

private final java.lang.String text

Suppression text.

lineNo

private final int lineNo

Suppression line.

columnNo

private final int columnNo

Suppression column number.

suppressionType

private final SuppressWithPlainTextCommentFilter.SuppressionType suppressionType

Suppression type.

Constructor Detail

Suppression

Suppression(java.lang.String text,
            int lineNo,
            int columnNo,
            SuppressWithPlainTextCommentFilter.SuppressionType suppressionType,
            SuppressWithPlainTextCommentFilter filter)

Creates new suppression instance.

Parameters:

text - suppression text.

lineNo - suppression line number.

columnNo - suppression column number.

suppressionType - suppression type.

filter - the SuppressWithPlainTextCommentFilter with the context.

Throws:

java.lang.IllegalArgumentException - if there is an error in the filter regex syntax.

Method Detail

equals

public boolean equals(java.lang.Object other)

Indicates whether some other object is "equal to" this one. Suppression on enumeration is needed so code stays consistent.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

isMatch

private boolean isMatch(AuditEvent event)

Checks whether the suppression matches the given AuditEvent.

Parameters:

event - AuditEvent instance.

Returns:

true if the suppression matches AuditEvent.

isInScopeOfSuppression

private boolean isInScopeOfSuppression(AuditEvent event)

Checks whether AuditEvent is in the scope of the suppression.

Parameters:

event - AuditEvent instance.

Returns:

true if AuditEvent is in the scope of the suppression.

isCheckMatch

private boolean isCheckMatch(AuditEvent event)

Checks whether AuditEvent source name matches the check format.

Parameters:

event - AuditEvent instance.

Returns:

true if the AuditEvent source name matches the check format.

isIdMatch

private boolean isIdMatch(AuditEvent event)

Checks whether the AuditEvent module ID matches the ID format.

Parameters:

event - AuditEvent instance.

Returns:

true if the AuditEvent module ID matches the ID format.

isMessageMatch

private boolean isMessageMatch(AuditEvent event)

Checks whether the AuditEvent message matches the message format.

Parameters:

event - AuditEvent instance.

Returns:

true if the AuditEvent message matches the message format.