com.puppycrawl.tools.checkstyle.checks.blocks

Class LeftCurlyCheck

public class LeftCurlyCheck extends AbstractOptionCheck

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.

The policy to verify is specified using the LeftCurlyOption class and defaults to EOL. Policies EOL and 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 NLOW and maxLineLength 120 is:

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

Version: 1.0

Author: Oliver Burn lkuehne

Constructor Summary
LeftCurlyCheck()
Creates a default instance and sets the policy to EOL.
Method Summary
int[]getDefaultTokens()
voidsetMaxLineLength(int aMaxLineLength)
Sets the maximum line length used in calculating the placement of the left curly brace.
voidvisitToken(DetailAST aAST)

Constructor Detail

LeftCurlyCheck

public LeftCurlyCheck()
Creates a default instance and sets the policy to EOL.

Method Detail

getDefaultTokens

public int[] getDefaultTokens()
{@inheritDoc }

setMaxLineLength

public void setMaxLineLength(int aMaxLineLength)
Sets the maximum line length used in calculating the placement of the left curly brace.

Parameters: aMaxLineLength the max allowed line length

visitToken

public void visitToken(DetailAST aAST)
{@inheritDoc }