Package com.puppycrawl.tools.checkstyle.checks.coding

Class UnnecessarySemicolonInTryWithResourcesCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public final class UnnecessarySemicolonInTryWithResourcesCheck
extends AbstractCheck

    Checks if unnecessary semicolon is used in last resource declaration.

    • Property allowWhenNoBraceAfterSemicolon - Allow unnecessary semicolon if closing paren is not on the same line. Type is boolean. Default value is true.

    To configure the check: 

     <module name="UnnecessarySemicolonInTryWithResources"/>

    Example of violations 

     class A {
     void method() throws IOException {
         try(Reader r1 = new PipedReader();){} // violation
         try(Reader r4 = new PipedReader();Reader r5 = new PipedReader()
         ;){} // violation
         try(Reader r6 = new PipedReader();
             Reader r7
                    = new PipedReader();
         ){}
     }
 }

    To configure the check to detect unnecessary semicolon if closing paren is not on same line 

     <module name="UnnecessarySemicolonInTryWithResources">
   <property name="allowWhenNoBraceAfterSemicolon" value="false"/>
 </module>

    Example of exclusion 

     class A {
     void method() throws IOException {
         try(Reader r1 = new PipedReader();){} // violation
         try(Reader r6 = new PipedReader();
             Reader r7 = new PipedReader(); // violation
         ){}
     }
 }

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • unnecessary.semicolon
    Since:
    8.22

    • Field Detail

      • MSG_SEMI

        public static final java.lang.String MSG_SEMI
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

    • Constructor Detail

      • UnnecessarySemicolonInTryWithResourcesCheck

        public UnnecessarySemicolonInTryWithResourcesCheck()

    • Method Detail

      • 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.
        Specified by:
        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.
        Specified by:
        getRequiredTokens in class AbstractCheck
        Returns:
        the token set this must be registered for.
        See Also:
        TokenTypes

      • setAllowWhenNoBraceAfterSemicolon

        public void setAllowWhenNoBraceAfterSemicolon​(boolean allowWhenNoBraceAfterSemicolon)
        Setter to allow unnecessary semicolon if closing paren is not on the same line.
        Parameters:
        allowWhenNoBraceAfterSemicolon - a value to set.