ua.gradsoft.javachecker
Class CheckerComment

java.lang.Object
  extended by ua.gradsoft.javachecker.CheckerComment

public class CheckerComment
extends java.lang.Object

This class is a checker comment: i. e. expression, which developer put in comment before checked expression. example:

!checker: disable(all) !
class X {
  .....
}
will disable all check in this class.
!checker: disable(style)
will disable style checks.

Author:
Ruslan Shevchenko

Method Summary
static CheckerComment extract(java.lang.String comment)
          try to extract checker comment from comment.
 boolean isBean()
           
 boolean isDisable(java.lang.String checkName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

isBean

public boolean isBean()

isDisable

public boolean isDisable(java.lang.String checkName)

extract

public static CheckerComment extract(java.lang.String comment)
                              throws InvalidCheckerCommentException
try to extract checker comment from comment.

Parameters:
Comment - - comment to extract from.
Returns:
Parsed checker comment, if it was found. null, otherwise
Throws:
InvalidCheckerCommentExcepton - if we find checker comment, but expression inside is incorrect.
InvalidCheckerCommentException