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 ParenPadCheck  

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.ParenPadCheck

All Implemented Interfaces:

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

---

public class ParenPadCheck

extends AbstractOptionCheck

Checks the padding of parentheses; that is whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden, with the exception that it does not check for padding of the right parenthesis at an empty for iterator. Use Check EmptyForIteratorPad to validate empty for iterators.

The policy to verify is specified using the PadOption class and defaults to PadOption.NOSPACE 55 .

By default the check will check parentheses that occur with the following tokens: CTOR_CALL 55 , LPAREN 55 , METHOD_CALL 55 , RPAREN 55 , SUPER_CTOR_CALL 55 , TYPECAST 55 .

An example of how to configure the check is:

 <module name="ParenPad"/>
 

An example of how to configure the check to require spaces for the parentheses of constructor, method, and super constructor invocations is:

 <module name="ParenPad">
     <property name="tokens"
               value="CTOR_CALL, METHOD_CALL, SUPER_CTOR_CALL"/>
     <property name="option" value="space"/>
 </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

ParenPadCheck()           Sets the paren pad otion to nospace.

 

Method Summary
int[]	getDefaultTokens()           Returns the default token a check is interested in.
private  void	processLeft(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)           Process a token representing a left parentheses.
private  void	processRight(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)           Process a token representing a right parentheses.
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

ParenPadCheck

public ParenPadCheck()

Sets the paren pad otion to nospace.

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.

---

processLeft

private void processLeft(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)

Process a token representing a left parentheses.

---

processRight

private void processRight(com.puppycrawl.tools.checkstyle.api.DetailAST aAST)

Process a token representing a right parentheses.

---

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

---