View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2024 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ///////////////////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle.checks.coding;
21  
22  import com.puppycrawl.tools.checkstyle.StatelessCheck;
23  
24  /**
25   * <p>
26   * Checks that an overriding {@code finalize()} method invokes {@code super.finalize()}.
27   * Does not check native methods, as they have no possible java defined implementation.
28   * </p>
29   * <p>
30   * References:
31   * <a href="https://www.oracle.com/technical-resources/articles/javase/finalization.html">
32   * How to Handle Java Finalization's Memory-Retention Issues</a>;
33   * <a href="https://javarevisited.blogspot.com/2012/03/finalize-method-in-java-tutorial.html">
34   * 10 points on finalize method in Java</a>.
35   * </p>
36   * <p>
37   * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
38   * </p>
39   * <p>
40   * Violation Message Keys:
41   * </p>
42   * <ul>
43   * <li>
44   * {@code missing.super.call}
45   * </li>
46   * </ul>
47   *
48   * @since 3.2
49   */
50  @StatelessCheck
51  public class SuperFinalizeCheck extends AbstractSuperCheck {
52  
53      @Override
54      protected String getMethodName() {
55          return "finalize";
56      }
57  
58  }