Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

com.puppycrawl.tools.checkstyle.checks
Class EmptyBlockCheck  view EmptyBlockCheck download EmptyBlockCheck.java

java.lang.Object
  extended bycom.puppycrawl.tools.checkstyle.api.AutomaticBean
      extended bycom.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          extended bycom.puppycrawl.tools.checkstyle.api.Check
              extended bycom.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck
                  extended bycom.puppycrawl.tools.checkstyle.checks.EmptyBlockCheck
All Implemented Interfaces:
com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class EmptyBlockCheck
extends AbstractOptionCheck

Checks for empty blocks. The policy to verify is specified using the BlockOption class and defaults to BlockOption.STMT 55 .

By default the check will check the following blocks: LITERAL_WHILE 55 , LITERAL_TRY 55 , LITERAL_CATCH 55 , LITERAL_FINALLY 55 , LITERAL_DO 55 , LITERAL_IF 55 , LITERAL_ELSE 55 , LITERAL_FOR 55 , STATIC_INIT 55 .

An example of how to configure the check is:

 <module name="EmptyBlock"/>
 

An example of how to configure the check for the BlockOption.TEXT 55 policy and only catch blocks is:

 <module name="EmptyBlock">
    <property name="tokens" value="LITERAL_CATCH"/>
    <property name="option" value="text"/>
 </module>
 


Field Summary
 
Fields inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck
 
Fields inherited from class com.puppycrawl.tools.checkstyle.api.Check
 
Fields inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
 
Fields inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
 
Constructor Summary
EmptyBlockCheck()
          Creates a new EmptyBlockCheck instance.
 
Method Summary
 int[] getDefaultTokens()
          Returns the default token a check is interested in.
private  boolean hasText(com.puppycrawl.tools.checkstyle.api.DetailAST aSlistAST)
           
 void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
          Called to process a token.
 
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck
getAbstractOption, setOption
 
Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
 
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, 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

EmptyBlockCheck

public EmptyBlockCheck()
Creates a new EmptyBlockCheck instance.

Method Detail

getDefaultTokens

public int[] getDefaultTokens()
Description copied from class: com.puppycrawl.tools.checkstyle.api.Check
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.


visitToken

public void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
Description copied from class: com.puppycrawl.tools.checkstyle.api.Check
Called to process a token.


hasText

private boolean hasText(com.puppycrawl.tools.checkstyle.api.DetailAST aSlistAST)