com.puppycrawl.tools.checkstyle.checks.blocks

Class LeftCurlyCheck

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.blocks.LeftCurlyCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class LeftCurlyCheck
extends AbstractCheck

Checks the placement of left curly braces on types, methods and other blocks: LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, STATIC_INIT, LAMBDA.

The policy to verify is specified using the LeftCurlyOption class and defaults to LeftCurlyOption.EOL. Policies LeftCurlyOption.EOL and LeftCurlyOption.NLOW take into account property maxLineLength. The default value for maxLineLength is 80.

An example of how to configure the check is:

 <module name="LeftCurly"/>
 

An example of how to configure the check with policy LeftCurlyOption.NLOW and maxLineLength 120 is:

 <module name="LeftCurly">
      <property name="option"
 value="nlow"/>     <property name="maxLineLength" value="120"/> <
 /module>
 

An example of how to configure the check to validate enum definitions:

 <module name="LeftCurly">
      <property name="ignoreEnums" value="false"/>
 </module>
 

Author:

Oliver Burn, lkuehne, maxvetrenko

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_KEY_LINE_BREAK_AFTER A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_KEY_LINE_NEW A key is pointing to the warning message text in "messages.properties" file.
static String	MSG_KEY_LINE_PREVIOUS A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
LeftCurlyCheck()

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.
void	setIgnoreEnums(boolean ignoreEnums) Sets whether check should ignore enums when left curly brace policy is EOL.
void	setMaxLineLength(int maxLineLength) Deprecated. since 6.10 release, option is not required for the Check.
void	setOption(String optionStr) Set the option to enforce.
void	visitToken(DetailAST ast) Called to process a token.

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

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

MSG_KEY_LINE_NEW

public static final String MSG_KEY_LINE_NEW

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

See Also:

Constant Field Values

MSG_KEY_LINE_PREVIOUS

public static final String MSG_KEY_LINE_PREVIOUS

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

See Also:

Constant Field Values

MSG_KEY_LINE_BREAK_AFTER

public static final String MSG_KEY_LINE_BREAK_AFTER

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

See Also:

Constant Field Values

Constructor Detail

LeftCurlyCheck

public LeftCurlyCheck()

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

setMaxLineLength

@Deprecated
public void setMaxLineLength(int maxLineLength)

Deprecated. since 6.10 release, option is not required for the Check.

Sets the maximum line length used in calculating the placement of the left curly brace.

Parameters:

maxLineLength - the max allowed line length

setIgnoreEnums

public void setIgnoreEnums(boolean ignoreEnums)

Sets whether check should ignore enums when left curly brace policy is EOL.

Parameters:

ignoreEnums - check's option for ignoring enums.

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: AbstractCheck

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 AbstractCheck

Returns:

the default tokens

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: AbstractCheck

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 AbstractCheck

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: AbstractCheck

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class AbstractCheck

Returns:

the token set this must be registered for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process