Package com.puppycrawl.tools.checkstyle.checks.whitespace

Class AbstractParenPadCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

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.

Nested Class Summary

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

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
private static final char	CLOSE_PARENTHESIS	Close parenthesis literal.
private final String	msgWsFollowed	Message key for followed whitespace.
private final String	msgWsNotFollowed	Message key for not followed whitespace.
private final String	msgWsNotPreceded	Message key for not preceded whitespace.
private final String	msgWsPreceded	Message key for preceded whitespace.
private static final char	OPEN_PARENTHESIS	Open parenthesis literal.
private PadOption	option	The policy to enforce.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractParenPadCheck(String msgWsFollowed, String msgWsNotFollowed, String msgWsPreceded, String msgWsNotPreceded)	Creates a new AbstractParenPadCheck instance.

Method Summary

Modifier and Type	Method	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)	Specify policy on how to pad parentheses.

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

beginTree, clearViolations, destroy, finishTree, getAcceptableTokens, getDefaultTokens, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getRequiredTokens, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, 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.AbstractAutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Details

OPEN_PARENTHESIS

private static final char OPEN_PARENTHESIS

Open parenthesis literal.

See Also:

• Constant Field Values

CLOSE_PARENTHESIS

private static final char CLOSE_PARENTHESIS

Close parenthesis literal.

See Also:

• Constant Field Values

msgWsFollowed

private final String msgWsFollowed

Message key for followed whitespace.

msgWsNotFollowed

private final String msgWsNotFollowed

Message key for not followed whitespace.

msgWsPreceded

private final String msgWsPreceded

Message key for preceded whitespace.

msgWsNotPreceded

private final String msgWsNotPreceded

Message key for not preceded whitespace.

option

private PadOption option

The policy to enforce.

Constructor Details

AbstractParenPadCheck

protected AbstractParenPadCheck(String msgWsFollowed,
 String msgWsNotFollowed,
 String msgWsPreceded,
 String msgWsNotPreceded)

Creates a new AbstractParenPadCheck instance.

Parameters:

msgWsFollowed - message key for followed whitespace

msgWsNotFollowed - message key for not followed whitespace

msgWsPreceded - message key for preceded whitespace

msgWsNotPreceded - message key for not preceded whitespace

Method Details

setOption

public void setOption(String optionStr)

Specify policy on how to pad parentheses.

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