com.puppycrawl.tools.checkstyle.filters

Class SuppressionCommentFilter.Tag

java.lang.Object

com.puppycrawl.tools.checkstyle.filters.SuppressionCommentFilter.Tag

All Implemented Interfaces:

java.lang.Comparable<SuppressionCommentFilter.Tag>

Enclosing class:

SuppressionCommentFilter

private static final class SuppressionCommentFilter.Tag
extends java.lang.Object
implements java.lang.Comparable<SuppressionCommentFilter.Tag>

A Tag holds a suppression comment and its location, and determines whether the suppression turns checkstyle reporting on or off.

Field Summary

Fields

Modifier and Type	Field and Description
private int	column The column number of the tag.
private int	line The line number of the tag.
private java.util.regex.Pattern	tagCheckRegexp The parsed check regexp, expanded for the text of this tag.
private java.util.regex.Pattern	tagIdRegexp The parsed check ID regexp, expanded for the text of this tag.
private java.util.regex.Pattern	tagMessageRegexp The parsed message regexp, expanded for the text of this tag.
private SuppressionCommentFilter.TagType	tagType Determines whether the suppression turns checkstyle reporting on.
private java.lang.String	text The text of the tag.

Constructor Summary

Constructors

Constructor and Description
Tag(int line, int column, java.lang.String text, SuppressionCommentFilter.TagType tagType, SuppressionCommentFilter filter) Constructs a tag.

Method Summary

Modifier and Type	Method and Description
int	compareTo(SuppressionCommentFilter.Tag object) Compares the position of this tag in the file with the position of another tag.
boolean	equals(java.lang.Object other) Indicates whether some other object is "equal to" this one.
int	getColumn() Determines the column number of the tag in the source file.
int	getLine() Returns line number of the tag in the source file.
SuppressionCommentFilter.TagType	getTagType() Determines whether the suppression turns checkstyle reporting on or off.
int	hashCode()
private boolean	isCheckMatch(TreeWalkerAuditEvent event) Checks whether TreeWalkerAuditEvent source name matches the check format.
private boolean	isIdMatch(TreeWalkerAuditEvent event) Checks whether the TreeWalkerAuditEvent module ID matches the ID format.
boolean	isMatch(TreeWalkerAuditEvent event) Determines whether the source of an audit event matches the text of this tag.
private boolean	isMessageMatch(TreeWalkerAuditEvent event) Checks whether the TreeWalkerAuditEvent message matches the message format.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

text

private final java.lang.String text

The text of the tag.

line

private final int line

The line number of the tag.

column

private final int column

The column number of the tag.

tagType

private final SuppressionCommentFilter.TagType tagType

Determines whether the suppression turns checkstyle reporting on.

tagCheckRegexp

private final java.util.regex.Pattern tagCheckRegexp

The parsed check regexp, expanded for the text of this tag.

tagMessageRegexp

private final java.util.regex.Pattern tagMessageRegexp

The parsed message regexp, expanded for the text of this tag.

tagIdRegexp

private final java.util.regex.Pattern tagIdRegexp

The parsed check ID regexp, expanded for the text of this tag.

Constructor Detail

Tag

Tag(int line,
    int column,
    java.lang.String text,
    SuppressionCommentFilter.TagType tagType,
    SuppressionCommentFilter filter)

Constructs a tag.

Parameters:

line - the line number.

column - the column number.

text - the text of the suppression.

tagType - ON if the tag turns checkstyle reporting.

filter - the SuppressionCommentFilter with the context

Throws:

java.lang.IllegalArgumentException - if unable to parse expanded text.

Method Detail

getLine

public int getLine()

Returns line number of the tag in the source file.

Returns:

the line number of the tag in the source file.

getColumn

public int getColumn()

Determines the column number of the tag in the source file. Will be 0 for all lines of multiline comment, except the first line.

Returns:

the column number of the tag in the source file.

getTagType

public SuppressionCommentFilter.TagType getTagType()

Determines whether the suppression turns checkstyle reporting on or off.

Returns:

ON if the suppression turns reporting on.

compareTo

public int compareTo(SuppressionCommentFilter.Tag object)

Compares the position of this tag in the file with the position of another tag.

Specified by:

compareTo in interface java.lang.Comparable<SuppressionCommentFilter.Tag>

Parameters:

object - the tag to compare with this one.

Returns:

a negative number if this tag is before the other tag, 0 if they are at the same position, and a positive number if this tag is after the other tag.

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

public boolean isMatch(TreeWalkerAuditEvent event)

Determines whether the source of an audit event matches the text of this tag.

Parameters:

event - the TreeWalkerAuditEvent to check.

Returns:

true if the source of event matches the text of this tag.

isCheckMatch

private boolean isCheckMatch(TreeWalkerAuditEvent event)

Checks whether TreeWalkerAuditEvent source name matches the check format.

Parameters:

event - TreeWalkerAuditEvent instance.

Returns:

true if the TreeWalkerAuditEvent source name matches the check format.

isIdMatch

private boolean isIdMatch(TreeWalkerAuditEvent event)

Checks whether the TreeWalkerAuditEvent module ID matches the ID format.

Parameters:

event - TreeWalkerAuditEvent instance.

Returns:

true if the TreeWalkerAuditEvent module ID matches the ID format.

isMessageMatch

private boolean isMessageMatch(TreeWalkerAuditEvent event)

Checks whether the TreeWalkerAuditEvent message matches the message format.

Parameters:

event - TreeWalkerAuditEvent instance.

Returns:

true if the TreeWalkerAuditEvent message matches the message format.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object