001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2023 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018///////////////////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.checks.coding;
021
022import com.puppycrawl.tools.checkstyle.StatelessCheck;
023
024/**
025 * <p>
026 * Checks that an overriding {@code finalize()} method invokes {@code super.finalize()}.
027 * Does not check native methods, as they have no possible java defined implementation.
028 * </p>
029 * <p>
030 * References:
031 * <a href="https://www.oracle.com/technical-resources/articles/javase/finalization.html">
032 * How to Handle Java Finalization's Memory-Retention Issues</a>;
033 * <a href="https://javarevisited.blogspot.com/2012/03/finalize-method-in-java-tutorial.html">
034 * 10 points on finalize method in Java</a>.
035 * </p>
036 * <p>
037 * To configure the check:
038 * </p>
039 * <pre>
040 * &lt;module name=&quot;SuperFinalize&quot;/&gt;
041 * </pre>
042 * <p>Example:</p>
043 * <pre>
044 * public class A {
045 *      protected void finalize() throws Throwable {
046 *         System.out.println("In finalize block");
047 *          super.finalize(); // OK, calls super.finalize()
048 *      }
049 * }
050 * public class B {
051 *      protected void finalize() throws Throwable { // violation
052 *          System.out.println("In finalize block");
053 *      }
054 * }
055 * </pre>
056 * <p>
057 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
058 * </p>
059 * <p>
060 * Violation Message Keys:
061 * </p>
062 * <ul>
063 * <li>
064 * {@code missing.super.call}
065 * </li>
066 * </ul>
067 *
068 * @since 3.2
069 */
070@StatelessCheck
071public class SuperFinalizeCheck extends AbstractSuperCheck {
072
073    @Override
074    protected String getMethodName() {
075        return "finalize";
076    }
077
078}