001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2017 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.api.AbstractCheck;
023import com.puppycrawl.tools.checkstyle.api.DetailAST;
024import com.puppycrawl.tools.checkstyle.api.TokenTypes;
025
026/**
027 * Provide support for checking for a method with a specified name and no
028 * arguments.
029 * @deprecated Checkstyle will not support abstract checks anymore. Use
030 *             {@link AbstractCheck} instead.
031 * @author Oliver Burn
032 * @noinspection AbstractClassNeverImplemented
033 */
034@Deprecated
035public abstract class AbstractIllegalMethodCheck extends AbstractCheck {
036    /** Name of method to disallow. */
037    private final String methodName;
038    /** The error key to report with. */
039    private final String errorKey;
040
041    /**
042     * Creates an instance.
043     * @param methodName name of the method to disallow.
044     * @param errorKey the error key to report with.
045     */
046    protected AbstractIllegalMethodCheck(String methodName, String errorKey) {
047        this.methodName = methodName;
048        this.errorKey = errorKey;
049    }
050
051    @Override
052    public int[] getDefaultTokens() {
053        return getAcceptableTokens();
054    }
055
056    @Override
057    public int[] getAcceptableTokens() {
058        return new int[] {TokenTypes.METHOD_DEF};
059    }
060
061    @Override
062    public int[] getRequiredTokens() {
063        return getAcceptableTokens();
064    }
065
066    @Override
067    public void visitToken(DetailAST aAST) {
068        final DetailAST mid = aAST.findFirstToken(TokenTypes.IDENT);
069        final String name = mid.getText();
070
071        if (methodName.equals(name)) {
072
073            final DetailAST params = aAST.findFirstToken(TokenTypes.PARAMETERS);
074            final boolean hasEmptyParamList =
075                !params.branchContains(TokenTypes.PARAMETER_DEF);
076
077            if (hasEmptyParamList) {
078                log(aAST.getLineNo(), errorKey);
079            }
080        }
081    }
082}