Class LeftCurlyCheck

All Implemented Interfaces:
Configurable, Contextualizable

public class LeftCurlyCheck extends AbstractCheck

Checks for the placement of left curly braces ('{') for code blocks.

To configure the check:

 <module name="LeftCurly"/>
 

To configure the check to apply the nl policy to type blocks:

 <module name="LeftCurly">
   <property name="option" value="nl"/>
   <property name="tokens" value="CLASS_DEF,INTERFACE_DEF"/>
 </module>
 

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

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

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

  • line.break.after
  • line.new
  • line.previous
Since:
3.0
  • Field Details

    • 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:
    • 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:
    • 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:
  • Constructor Details

    • LeftCurlyCheck

      public LeftCurlyCheck()
  • Method Details

    • setOption

      public void setOption(String optionStr)
      Setter to specify the policy on placement of a left curly brace ('{').
      Parameters:
      optionStr - string to decode option from
      Throws:
      IllegalArgumentException - if unable to decode
    • setIgnoreEnums

      public void setIgnoreEnums(boolean ignoreEnums)
      Setter to allow to 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:
    • 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.
      Specified by:
      getAcceptableTokens in class AbstractCheck
      Returns:
      the token set this check is designed for.
      See Also:
    • getRequiredTokens

      public int[] getRequiredTokens()
      Description copied from class: AbstractCheck
      The tokens that this check must be registered for.
      Specified by:
      getRequiredTokens in class AbstractCheck
      Returns:
      the token set this must be registered for.
      See Also:
    • visitToken

      public void visitToken(DetailAST ast)
      We cannot reduce the number of branches in this switch statement, since many tokens require specific methods to find the first left curly.
      Overrides:
      visitToken in class AbstractCheck
      Parameters:
      ast - the token to process