001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2014  Oliver Burn
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////////////////////////////////////////////////////////////////////////////////
019package com.puppycrawl.tools.checkstyle.checks.coding;
020
021import com.puppycrawl.tools.checkstyle.api.Check;
022import com.puppycrawl.tools.checkstyle.api.DetailAST;
023import com.puppycrawl.tools.checkstyle.api.TokenTypes;
024
025/**
026 * Provide support for checking for a method with a specified name and no
027 * arguments.
028 * @author Oliver Burn
029 */
030public abstract class AbstractIllegalMethodCheck extends Check
031{
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    public AbstractIllegalMethodCheck(String methodName, String errorKey)
043    {
044        this.methodName = methodName;
045        this.errorKey = errorKey;
046    }
047
048    @Override
049    public int[] getDefaultTokens()
050    {
051        return new int[] {TokenTypes.METHOD_DEF};
052    }
053
054    @Override
055    public void visitToken(DetailAST aAST)
056    {
057        final DetailAST mid = aAST.findFirstToken(TokenTypes.IDENT);
058        final String name = mid.getText();
059
060        if (methodName.equals(name)) {
061
062            final DetailAST params = aAST.findFirstToken(TokenTypes.PARAMETERS);
063            final boolean hasEmptyParamList =
064                !params.branchContains(TokenTypes.PARAMETER_DEF);
065
066            if (hasEmptyParamList) {
067                log(aAST.getLineNo(), errorKey);
068            }
069        }
070    }
071}