com.puppycrawl.tools.checkstyle.checks

Class TodoCommentCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class TodoCommentCheck
extends Check

A check for TODO comments. To check for other patterns in Java comments, set property format.

An example of how to configure the check is:

 <module name="TodoComment"/>
 

An example of how to configure the check for comments that contain WARNING is:

 <module name="TodoComment">
    <property name="format" value="WARNING"/>
 </module>
 

Version:

1.0

Author:

Oliver Burn, Baratali Izmailov

Constructor Summary

Constructors

Constructor and Description
TodoCommentCheck()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getDefaultTokens() Returns the default token a check is interested in.
boolean	isCommentNodesRequired()
void	setFormat(String format) Setter for todo comment format.
void	visitToken(DetailAST ast) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TodoCommentCheck

public TodoCommentCheck()

Method Detail

isCommentNodesRequired

public boolean isCommentNodesRequired()

Overrides:

isCommentNodesRequired in class Check

setFormat

public void setFormat(String format)

Setter for todo comment format.

Parameters:

format - format of todo comment.

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class Check

Returns:

the default tokens

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

ast - the token to process