Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ checks overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---

com.puppycrawl.tools.checkstyle.checks
Class OperatorWrapCheck  

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.AbstractOptionCheck
                  com.puppycrawl.tools.checkstyle.checks.OperatorWrapCheck

All Implemented Interfaces:

com.puppycrawl.tools.checkstyle.api.Configurable, com.puppycrawl.tools.checkstyle.api.Contextualizable

---

public class OperatorWrapCheck

extends AbstractOptionCheck

Checks line wrapping for operators. The policy to verify is specified using the OperatorWrapOption class and defaults to OperatorWrapOption.NL 55 .

By default the check will check the following operators: BAND 55 , BOR 55 , BSR 55 , BXOR 55 , COLON 55 , DIV 55 , EQUAL 55 , GE 55 , GT 55 , LAND 55 , LE 55 , LITERAL_INSTANCEOF 55 , LOR 55 , LT 55 , MINUS 55 , MOD 55 , NOT_EQUAL 55 , PLUS 55 , QUESTION 55 , SL 55 , SR 55 , STAR 55 . Other acceptable tokens are ASSIGN 55 , BAND_ASSIGN 55 , BOR_ASSIGN 55 , BSR_ASSIGN 55 , BXOR_ASSIGN 55 , DIV_ASSIGN 55 , MINUS_ASSIGN 55 , MOD_ASSIGN 55 , PLUS_ASSIGN 55 , SL_ASSIGN 55 , SR_ASSIGN 55 , STAR_ASSIGN 55 .

An example of how to configure the check is:

 <module name="OperatorWrap"/>
 

An example of how to configure the check for assignment operators at the end of a line is:

 <module name="OperatorWrap">
     <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"/>
     <property name="option" value="eol"/>
 </module>
 

Version:

1.0

---

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

OperatorWrapCheck()           Sets the operator wrap option to new line.

 

Method Summary
int[]	getAcceptableTokens()           The configurable token set.
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.checks.AbstractOptionCheck

getAbstractOption, setOption

 

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

beginTree, destroy, finishTree, 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

OperatorWrapCheck

public OperatorWrapCheck()

Sets the operator wrap option to new line.

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.

---

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: com.puppycrawl.tools.checkstyle.api.Check

The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default 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.

---

Overview  Package   Class  Use  Deprecated  Index
Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ checks overview ]	PREV CLASS  NEXT CLASS
SUMMARY:  JAVADOC |  SOURCE |  DOWNLOAD | NESTED | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

---