java5parsingCheckstyleGrammar
Class GimmeComments

java.lang.Object
  extended by java5parsingCheckstyleGrammar.GimmeComments
All Implemented Interfaces:
CommentListener

public class GimmeComments
extends java.lang.Object
implements CommentListener

This is a comment listener which can report comments. The two methods are called during the lexing step.

Author:
Jan Hinzmann

Constructor Summary
GimmeComments()
           
 
Method Summary
 void reportBlockComment(java.lang.String aType, int aStartLineNo, int aStartColNo, int aEndLineNo, int aEndColNo)
          Report the location of a block comment that can span multiple lines.
 void reportSingleLineComment(java.lang.String aType, int aStartLineNo, int aStartColNo)
          Report the location of a single line comment that extends from the given point to the end of the line.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GimmeComments

public GimmeComments()
Method Detail

reportBlockComment

public void reportBlockComment(java.lang.String aType,
                               int aStartLineNo,
                               int aStartColNo,
                               int aEndLineNo,
                               int aEndColNo)
Description copied from interface: CommentListener
Report the location of a block comment that can span multiple lines. The type of comment is identified by a String whose value depends on the language being parsed, but would typically be the delimiter for the comment.

Specified by:
reportBlockComment in interface CommentListener
Parameters:
aType - an identifier for what type of comment it is.
aStartLineNo - the starting line number
aStartColNo - the starting column number
aEndLineNo - the ending line number
aEndColNo - the ending column number

reportSingleLineComment

public void reportSingleLineComment(java.lang.String aType,
                                    int aStartLineNo,
                                    int aStartColNo)
Description copied from interface: CommentListener
Report the location of a single line comment that extends from the given point to the end of the line. The type of comment is identified by a String whose value depends on the language being parsed, but would typically be the delimiter for the comment.

Specified by:
reportSingleLineComment in interface CommentListener
Parameters:
aType - an identifier for what type of comment it is.
aStartLineNo - the starting line number
aStartColNo - the starting column number


Copyright © 2007-2010. All Rights Reserved.