com.puppycrawl.tools.checkstyle.checks.blocks

Class LeftCurlyCheck

Implemented Interfaces:
Configurable, Contextualizable

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 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>
 
Version:
1.0
Authors:
Oliver Burn
lkuehne

Constructor Summary

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

Method Summary

int[]
getDefaultTokens()
void
setMaxLineLength(int aMaxLineLength)
Sets the maximum line length used in calculating the placement of the left curly brace.
void
visitToken(DetailAST aAST)

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, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken

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

getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setId, setSeverity

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Constructor Details

LeftCurlyCheck

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

Method Details

getDefaultTokens

public int[] getDefaultTokens()
Overrides:
getDefaultTokens in interface Check

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)
Overrides:
visitToken in interface Check