Package com.puppycrawl.tools.checkstyle.checks.blocks

Class RightCurlyCheck

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.blocks.RightCurlyCheck
All Implemented Interfaces:
Configurable, Contextualizable
public class RightCurlyCheck extends AbstractCheck
Checks the placement of right curly braces ('}') for code blocks. This check supports if-else, try-catch-finally blocks, switch statements, switch cases, while-loops, for-loops, method definitions, class definitions, constructor definitions, instance, static initialization blocks, annotation definitions and enum definitions. For right curly brace of expression blocks of arrays, lambdas and class instances please follow issue #5945. For right curly brace of enum constant please follow issue #7519.
  • Property option - Specify the policy on placement of a right curly brace ('}'). Type is com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyOption. Default value is same.
  • Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

  • line.alone
  • line.break.before
  • line.same
Since:
3.0

  • Field Details

  • Constructor Details

  • Method Details

    • setOption

      public void setOption(String optionStr)
      Setter to specify the policy on placement of a right curly brace ('}').
      Parameters:
      optionStr - string to decode option from
      Throws:
      IllegalArgumentException - if unable to decode
      Since:
      3.0

    • 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)
      Description copied from class: AbstractCheck
      Called to process a token.
      Overrides:
      visitToken in class AbstractCheck
      Parameters:
      ast - the token to process

    • validate

      private String validate(RightCurlyCheck.Details details)
      Does general validation.
      Parameters:
      details - for validation.
      Returns:
      violation message or empty string if there was no violation during validation.

    • shouldHaveLineBreakBefore

      private static boolean shouldHaveLineBreakBefore(RightCurlyOption bracePolicy, RightCurlyCheck.Details details)
      Checks whether a right curly should have a line break before.
      Parameters:
      bracePolicy - option for placing the right curly brace.
      details - details for validation.
      Returns:
      true if a right curly should have a line break before.

    • shouldBeOnSameLine

      private static boolean shouldBeOnSameLine(RightCurlyOption bracePolicy, RightCurlyCheck.Details details)
      Checks that a right curly should be on the same line as the next statement.
      Parameters:
      bracePolicy - option for placing the right curly brace
      details - Details for validation
      Returns:
      true if a right curly should be alone on a line.

    • shouldBeAloneOnLine

      private static boolean shouldBeAloneOnLine(RightCurlyOption bracePolicy, RightCurlyCheck.Details details, String targetSrcLine)
      Checks that a right curly should be alone on a line.
      Parameters:
      bracePolicy - option for placing the right curly brace
      details - Details for validation
      targetSrcLine - A string with contents of rcurly's line
      Returns:
      true if a right curly should be alone on a line.

    • shouldBeAloneOnLineWithAloneOption

      private static boolean shouldBeAloneOnLineWithAloneOption(RightCurlyCheck.Details details, String targetSrcLine)
      Whether right curly should be alone on line when ALONE option is used.
      Parameters:
      details - details for validation.
      targetSrcLine - A string with contents of rcurly's line
      Returns:
      true, if right curly should be alone on line when ALONE option is used.

    • shouldBeAloneOnLineWithNotAloneOption

      private static boolean shouldBeAloneOnLineWithNotAloneOption(RightCurlyCheck.Details details, String targetSrcLine)
      Whether right curly should be alone on line when ALONE_OR_SINGLELINE or SAME option is used.
      Parameters:
      details - details for validation.
      targetSrcLine - A string with contents of rcurly's line
      Returns:
      true, if right curly should be alone on line when ALONE_OR_SINGLELINE or SAME option is used.

    • isAloneOnLine

      private static boolean isAloneOnLine(RightCurlyCheck.Details details, String targetSrcLine)
      Checks whether right curly is alone on a line.
      Parameters:
      details - for validation.
      targetSrcLine - A string with contents of rcurly's line
      Returns:
      true if right curly is alone on a line.

    • skipDoubleBraceInstInit

      private static boolean skipDoubleBraceInstInit(RightCurlyCheck.Details details)
      This method determines if the double brace initialization should be skipped over by the check. Double brace initializations are treated differently. The corresponding inner rcurly is treated as if it was alone on line even when it may be followed by another rcurly and a semi, raising no violations. Please do note though that the line should not contain anything other than the following right curly and the semi following it or else violations will be raised. Only the kind of double brace initializations shown in the following example code will be skipped over:
           Map<String, String> map = new LinkedHashMap<>() {{
           put("alpha", "man");
       }}; // no violation
      Parameters:
      details - RightCurlyCheck.Details object containing the details relevant to the rcurly
      Returns:
      if the double brace initialization rcurly should be skipped over by the check

    • isBlockAloneOnSingleLine

      private static boolean isBlockAloneOnSingleLine(RightCurlyCheck.Details details)
      Checks whether block has a single-line format and is alone on a line.
      Parameters:
      details - for validation.
      Returns:
      true if block has single-line format and is alone on a line.

    • isRightcurlyFollowedBySemicolon

      private static boolean isRightcurlyFollowedBySemicolon(RightCurlyCheck.Details details)
      Checks whether the right curly is followed by a semicolon.
      Parameters:
      details - details for validation.
      Returns:
      true if the right curly is followed by a semicolon.

    • hasLineBreakBefore

      private static boolean hasLineBreakBefore(DetailAST rightCurly)
      Checks if right curly has line break before.
      Parameters:
      rightCurly - right curly token.
      Returns:
      true, if right curly has line break before.