1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2020 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.grammar;
21
22 /**
23 * This interface is used to be notified by parser about comments
24 * in the parsed code.
25 *
26 * @noinspection ClassOnlyUsedInOnePackage
27 */
28 public interface CommentListener {
29
30 /**
31 * Report the location of a single line comment that extends from the
32 * given point to the end of the line. The type of comment is identified
33 * by a String whose value depends on the language being parsed, but would
34 * typically be the delimiter for the comment.
35 *
36 * @param type an identifier for what type of comment it is.
37 * @param startLineNo the starting line number
38 * @param startColNo the starting column number
39 */
40 void reportSingleLineComment(String type,
41 int startLineNo, int startColNo);
42
43 /**
44 * Report the location of a block comment that can span multiple lines.
45 * The type of comment is identified by a String whose value depends on
46 * the language being parsed, but would typically be the delimiter for the
47 * comment.
48 *
49 * @param type an identifier for what type of comment it is.
50 * @param startLineNo the starting line number
51 * @param startColNo the starting column number
52 * @param endLineNo the ending line number
53 * @param endColNo the ending column number
54 */
55 void reportBlockComment(String type,
56 int startLineNo, int startColNo,
57 int endLineNo, int endColNo);
58
59 }