001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2026 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;
023import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
024import com.puppycrawl.tools.checkstyle.api.DetailAST;
025import com.puppycrawl.tools.checkstyle.api.TokenTypes;
026
027/**
028 * <div>
029 * Checks that there is no method {@code finalize} with zero parameters.
030 * </div>
031 *
032 * <p>
033 * See
034 * <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()">
035 * Object.finalize()</a>
036 * </p>
037 *
038 * <p>
039 * Rationale: Finalizers are unpredictable, often dangerous, and generally unnecessary.
040 * Their use can cause erratic behavior, poor performance, and portability problems.
041 * For more information for the finalize method and its issues, see Effective Java:
042 * Programming Language Guide Third Edition by Joshua Bloch, &#167;8.
043 * </p>
044 *
045 * @since 5.0
046 */
047@StatelessCheck
048public class NoFinalizerCheck extends AbstractCheck {
049
050    /**
051     * A key is pointing to the warning message text in "messages.properties"
052     * file.
053     */
054    public static final String MSG_KEY = "avoid.finalizer.method";
055
056    /**
057     * Creates a new {@code NoFinalizerCheck} instance.
058     */
059    public NoFinalizerCheck() {
060        // no code by default
061    }
062
063    @Override
064    public int[] getDefaultTokens() {
065        return getRequiredTokens();
066    }
067
068    @Override
069    public int[] getAcceptableTokens() {
070        return getRequiredTokens();
071    }
072
073    @Override
074    public int[] getRequiredTokens() {
075        return new int[] {TokenTypes.METHOD_DEF};
076    }
077
078    @Override
079    public void visitToken(DetailAST ast) {
080        final DetailAST mid = ast.findFirstToken(TokenTypes.IDENT);
081        final String name = mid.getText();
082
083        if ("finalize".equals(name)) {
084            final DetailAST params = ast.findFirstToken(TokenTypes.PARAMETERS);
085            final boolean hasEmptyParamList =
086                params.findFirstToken(TokenTypes.PARAMETER_DEF) == null;
087
088            if (hasEmptyParamList) {
089                log(ast, MSG_KEY);
090            }
091        }
092    }
093
094}