001/////////////////////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code and other text files for adherence to a set of rules. 003// Copyright (C) 2001-2024 the original author or authors. 004// 005// This library is free software; you can redistribute it and/or 006// modify it under the terms of the GNU Lesser General Public 007// License as published by the Free Software Foundation; either 008// version 2.1 of the License, or (at your option) any later version. 009// 010// This library is distributed in the hope that it will be useful, 011// but WITHOUT ANY WARRANTY; without even the implied warranty of 012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013// Lesser General Public License for more details. 014// 015// You should have received a copy of the GNU Lesser General Public 016// License along with this library; if not, write to the Free Software 017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 018/////////////////////////////////////////////////////////////////////////////////////////////// 019 020package com.puppycrawl.tools.checkstyle.checks.regexp; 021 022import com.puppycrawl.tools.checkstyle.api.FileContents; 023 024/** 025 * Implementation of a {@link MatchSuppressor} that suppresses based on 026 * whether in a comment. 027 */ 028class CommentSuppressor implements MatchSuppressor { 029 030 /** File contents to check for comments. */ 031 private final FileContents currentContents; 032 033 /** 034 * Constructor for this suppressor. 035 * 036 * @param currentContents 037 * content of checked file. 038 **/ 039 /* package */ CommentSuppressor(FileContents currentContents) { 040 this.currentContents = currentContents; 041 } 042 043 @Override 044 public boolean shouldSuppress(int startLineNo, int startColNo, 045 int endLineNo, int endColNo) { 046 return currentContents 047 .hasIntersectionWithComment(startLineNo, startColNo, endLineNo, endColNo); 048 } 049 050}