com.puppycrawl.tools.checkstyle.checks.whitespace

Class TypecastParenPadCheck

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<PadOption>

com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class TypecastParenPadCheck
extends AbstractOptionCheck<PadOption>

Checks the padding of parentheses for typecasts. That is whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden.

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

An example of how to configure the check is:

 <module name="TypecastParenPad"/>
 

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

 <module name="TypecastParenPad">
     <property name="option" value="space"/>
 </module>
 

Author:

Oliver Burn

Field Summary

Fields

Modifier and Type	Field and Description
static String	WS_FOLLOWED A key is pointing to the warning message text in "messages.properties" file.
static String	WS_NOT_FOLLOWED A key is pointing to the warning message text in "messages.properties" file.
static String	WS_NOT_PRECEDED A key is pointing to the warning message text in "messages.properties" file.
static String	WS_PRECEDED A key is pointing to the warning message text in "messages.properties" file.

Fields inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck

SEMICOLON

Constructor Summary

Constructors

Constructor and Description
TypecastParenPadCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
int[]	getRequiredTokens() The tokens that this check must be registered for.
protected void	processLeft(DetailAST ast) Process a token representing a left parentheses.
protected void	processRight(DetailAST ast) Process a token representing a right parentheses.
void	visitToken(DetailAST ast) 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, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

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

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, 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

Field Detail

WS_FOLLOWED

public static final String WS_FOLLOWED

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

WS_NOT_FOLLOWED

public static final String WS_NOT_FOLLOWED

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

WS_PRECEDED

public static final String WS_PRECEDED

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

WS_NOT_PRECEDED

public static final String WS_NOT_PRECEDED

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

Constructor Detail

TypecastParenPadCheck

public TypecastParenPadCheck()

Method Detail

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: Check

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class Check

Returns:

the token set this must be registered for.

See Also:

TokenTypes

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class Check

Returns:

the default tokens

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: 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.

Overrides:

getAcceptableTokens in class Check

Returns:

the token set this check is designed for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

ast - the token to process

processLeft

protected void processLeft(DetailAST ast)

Process a token representing a left parentheses.

Parameters:

ast - the token representing a left parentheses

processRight

protected void processRight(DetailAST ast)

Process a token representing a right parentheses.

Parameters:

ast - the token representing a right parentheses