com.puppycrawl.tools.checkstyle.checks.whitespace

Class ParenPadCheck

Implemented Interfaces:
Configurable, Contextualizable

public class ParenPadCheck
extends AbstractParenPadCheck

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.

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

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

Author:
Oliver Burn

Method Summary

int[]
getDefaultTokens()
void
visitToken(DetailAST aAST)

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck

processLeft, processRight

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, getDefaultTokens, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken

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

getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setSeverity

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Method Details

getDefaultTokens

public int[] getDefaultTokens()
Overrides:
getDefaultTokens in interface Check

See Also:
Check


visitToken

public void visitToken(DetailAST aAST)
Overrides:
visitToken in interface Check

See Also:
Check