com.puppycrawl.tools.checkstyle.filters

Class SuppressionCommentFilter.Tag

Enclosing Class:
SuppressionCommentFilter
Implemented Interfaces:
Comparable

public class SuppressionCommentFilter.Tag
extends java.lang.Object
implements Comparable

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

Author:
Rick Giles

Constructor Summary

Tag(int aLine, int aColumn, String aText, boolean aOn)
Constructs a tag.

Method Summary

int
compareTo(Object aObject)
Compares the position of this tag in the file with the position of another tag.
int
getColumn()
Determines the column number of the tag in the source file.
int
getLine()
String
getText()
boolean
isMatch(AuditEvent aEvent)
Determines whether the source of an audit event matches the text of this tag.
boolean
isOn()
Determines whether the suppression turns checkstyle reporting on or off.

Constructor Details

Tag

public Tag(int aLine,
           int aColumn,
           String aText,
           boolean aOn)
            throws ConversionException
Constructs a tag.

Parameters:
aLine - the line number.
aColumn - the column number.
aText - the text of the suppression.
aOn - true if the tag turns checkstyle reporting.

Method Details

compareTo

public int compareTo(Object aObject)
Compares the position of this tag in the file with the position of another tag.

Parameters:
aObject - 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.

See Also:
java.lang.Comparable.compareTo(java.lang.Object)


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.


getLine

public int getLine()

Returns:
the line number of the tag in the source file.


getText

public String getText()

Returns:
the text of the tag.


isMatch

public boolean isMatch(AuditEvent aEvent)
Determines whether the source of an audit event matches the text of this tag.

Parameters:
aEvent - the AuditEvent to check.

Returns:
true if the source of aEvent matches the text of this tag.


isOn

public boolean isOn()
Determines whether the suppression turns checkstyle reporting on or off.

Returns:
trueif the suppression turns reporting on.