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