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