001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2021 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>
043 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
044 * </p>
045 * <p>
046 * Violation Message Keys:
047 * </p>
048 * <ul>
049 * <li>
050 * {@code missing.super.call}
051 * </li>
052 * </ul>
053 *
054 * @since 3.2
055 */
056@StatelessCheck
057public class SuperFinalizeCheck extends AbstractSuperCheck {
058
059    @Override
060    protected String getMethodName() {
061        return "finalize";
062    }
063
064}