View Javadoc
1   /*
2    * Copyright (c) 2011-2024 Qulice.com
3    *
4    * All rights reserved.
5    *
6    * Redistribution and use in source and binary forms, with or without
7    * modification, are permitted provided that the following conditions
8    * are met: 1) Redistributions of source code must retain the above
9    * copyright notice, this list of conditions and the following
10   * disclaimer. 2) Redistributions in binary form must reproduce the above
11   * copyright notice, this list of conditions and the following
12   * disclaimer in the documentation and/or other materials provided
13   * with the distribution. 3) Neither the name of the Qulice.com nor
14   * the names of its contributors may be used to endorse or promote
15   * products derived from this software without specific prior written
16   * permission.
17   *
18   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT
20   * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
21   * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
22   * THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
23   * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24   * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26   * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
27   * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
29   * OF THE POSSIBILITY OF SUCH DAMAGE.
30   */
31  package com.qulice.checkstyle;
32  
33  import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
34  import com.puppycrawl.tools.checkstyle.api.DetailAST;
35  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
36  
37  /**
38   * Checks that try-with-resources does not end with a semicolon. Implementation
39   * relies on existence of semicolon inside of RESOURCE_SPECIFICATION token
40   * as interpreted by Checkstyle.
41   *
42   * @since 0.15
43   */
44  public final class FinalSemicolonInTryWithResourcesCheck extends AbstractCheck {
45  
46      @Override
47      public int[] getDefaultTokens() {
48          return new int[]{
49              TokenTypes.RESOURCE_SPECIFICATION,
50          };
51      }
52  
53      @Override
54      public int[] getAcceptableTokens() {
55          return this.getDefaultTokens();
56      }
57  
58      @Override
59      public int[] getRequiredTokens() {
60          return this.getDefaultTokens();
61      }
62  
63      @Override
64      public void visitToken(final DetailAST ast) {
65          final int semicolons = ast.getChildCount(TokenTypes.SEMI);
66          if (semicolons > 0) {
67              this.log(
68                  ast.getLineNo(),
69                  "Extra semicolon in the end of try-with-resources head."
70              );
71          }
72      }
73  }