KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > grammars > CommentListener


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