1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle.checks.regexp;
21
22 import com.puppycrawl.tools.checkstyle.api.FileContents;
23
24 /**
25 * Implementation of a {@link MatchSuppressor} that suppresses based on
26 * whether in a comment.
27 */
28 class CommentSuppressor implements MatchSuppressor {
29
30 /** File contents to check for comments. */
31 private final FileContents currentContents;
32
33 /**
34 * Constructor for this suppressor.
35 *
36 * @param currentContents
37 * content of checked file.
38 **/
39 /* package */ CommentSuppressor(FileContents currentContents) {
40 this.currentContents = currentContents;
41 }
42
43 @Override
44 public boolean shouldSuppress(int startLineNo, int startColNo,
45 int endLineNo, int endColNo) {
46 return currentContents
47 .hasIntersectionWithComment(startLineNo, startColNo, endLineNo, endColNo);
48 }
49
50 }