View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2018 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  /**
23   * Represents a suppressor for matches.
24   * @author oliver
25   */
26  @FunctionalInterface
27  public interface MatchSuppressor {
28  
29      /**
30       * Checks if the specified selection should be suppressed.
31       * @param startLineNo the starting line number
32       * @param startColNo the starting column number
33       * @param endLineNo the ending line number
34       * @param endColNo the ending column number
35       * @return true if the positions intersects with a comment.
36       **/
37      boolean shouldSuppress(int startLineNo, int startColNo, int endLineNo,
38              int endColNo);
39  
40  }