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

Quick Search    Search Deep

com.puppycrawl.tools.checkstyle.checks
Class WhitespaceAroundCheck  view WhitespaceAroundCheck download WhitespaceAroundCheck.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.WhitespaceAroundCheck
All Implemented Interfaces:
com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

public class WhitespaceAroundCheck
extends com.puppycrawl.tools.checkstyle.api.Check

Checks that a token is surrounded by whitespace.

By default the check will check the following operators: ASSERT 55 , ASSIGN 55 , BAND 55 , BAND_ASSIGN 55 , BOR 55 , BOR_ASSIGN 55 , BSR 55 , BSR_ASSIGN 55 , BXOR 55 , BXOR_ASSIGN 55 , COLON 55 , DIV 55 , DIV_ASSIGN 55 , EQUAL 55 , GE 55 , GT 55 , LAND 55 , LCURLY 55 , LE 55 , LITERAL_CATCH 55 , LITERAL_DO 55 , LITERAL_ELSE 55 , LITERAL_FINALLY 55 , LITERAL_FOR 55 , LITERAL_IF 55 , LITERAL_RETURN 55 , LITERAL_SYNCHRONIZED 55 , LITERAL_TRY 55 , LITERAL_WHILE 55 , LOR 55 , LT 55 , MINUS 55 , MINUS_ASSIGN 55 , MOD 55 , MOD_ASSIGN 55 , NOT_EQUAL 55 , PLUS 55 , PLUS_ASSIGN 55 , QUESTION 55 , RCURLY 55 , SL 55 , SLIST 55 , SL_ASSIGN 55 , SR 55 , SR_ASSIGN 55 , STAR 55 , STAR_ASSIGN 55 .

An example of how to configure the check is:

 <module name="WhitespaceAround"/>
 

An example of how to configure the check for whitespace only around assignment operators is:

 <module name="WhitespaceAround">
     <property name="tokens"
               value="ASSIGN,DIV_ASSIGN,PLUS_ASSIGN,MINUS_ASSIGN,STAR_ASSIGN,MOD_ASSIGN,SR_ASSIGN,BSR_ASSIGN,SL_ASSIGN,BXOR_ASSIGN,BOR_ASSIGN,BAND_ASSIGN"/>
 </module>
 

Version:
1.0

Field Summary
 
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
WhitespaceAroundCheck()
           
 
Method Summary
 int[] getDefaultTokens()
          Returns the default token a check is interested in.
 void visitToken(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)
          Called to process a token.
 
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

WhitespaceAroundCheck

public WhitespaceAroundCheck()
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.