com.puppycrawl.tools.checkstyle.checks.whitespace

Class AbstractParenPadCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck

All Implemented Interfaces:

Configurable, Contextualizable

Direct Known Subclasses:

ParenPadCheck, TypecastParenPadCheck

public abstract class AbstractParenPadCheck
extends AbstractCheck

Abstract class for checking 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.

Author:

Oliver Burn

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_WS_FOLLOWED A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_WS_NOT_FOLLOWED A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_WS_NOT_PRECEDED A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_WS_PRECEDED A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
AbstractParenPadCheck()

Method Summary

Modifier and Type	Method and Description
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	setOption(String optionStr) Set the option to enforce.

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

beginTree, clearMessages, destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLine, getLines, getMessages, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, setFileContents, setTabWidth, setTokens, visitToken

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

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

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

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MSG_WS_FOLLOWED

public static final String MSG_WS_FOLLOWED

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

See Also:

Constant Field Values

MSG_WS_NOT_FOLLOWED

public static final String MSG_WS_NOT_FOLLOWED

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

See Also:

Constant Field Values

MSG_WS_PRECEDED

public static final String MSG_WS_PRECEDED

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

See Also:

Constant Field Values

MSG_WS_NOT_PRECEDED

public static final String MSG_WS_NOT_PRECEDED

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

See Also:

Constant Field Values

Constructor Detail

AbstractParenPadCheck

public AbstractParenPadCheck()

Method Detail

setOption

public void setOption(String optionStr)

Set the option to enforce.

Parameters:

optionStr - string to decode option from

Throws:

IllegalArgumentException - if unable to decode

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