com.puppycrawl.tools.checkstyle.checks.regexp

Class CommentSuppressor

java.lang.Object

com.puppycrawl.tools.checkstyle.checks.regexp.CommentSuppressor

All Implemented Interfaces:

MatchSuppressor

class CommentSuppressor
extends java.lang.Object
implements MatchSuppressor

Implementation of a MatchSuppressor that suppresses based on whether in a comment.

Field Summary

Fields

Modifier and Type	Field and Description
private FileContents	currentContents File contents to check for comments.

Constructor Summary

Constructors

Constructor and Description
CommentSuppressor(FileContents currentContents) Constructor for this suppressor.

Method Summary

Modifier and Type	Method and Description
boolean	shouldSuppress(int startLineNo, int startColNo, int endLineNo, int endColNo) Checks if the specified selection should be suppressed.

Methods inherited from class java.lang.Object

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

Field Detail

currentContents

private final FileContents currentContents

File contents to check for comments.

Constructor Detail

CommentSuppressor

CommentSuppressor(FileContents currentContents)

Constructor for this suppressor.

Parameters:

currentContents - content of checked file.

Method Detail

shouldSuppress

public boolean shouldSuppress(int startLineNo,
                              int startColNo,
                              int endLineNo,
                              int endColNo)

Description copied from interface: MatchSuppressor

Checks if the specified selection should be suppressed.

Specified by:

shouldSuppress in interface MatchSuppressor

Parameters:

startLineNo - the starting line number

startColNo - the starting column number

endLineNo - the ending line number

endColNo - the ending column number

Returns:

true if the positions intersects with a comment.