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.naming;
021
022import java.util.regex.Pattern;
023
024import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
025import com.puppycrawl.tools.checkstyle.api.DetailAST;
026import com.puppycrawl.tools.checkstyle.api.TokenTypes;
027import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
028
029/**
030 * Abstract class for checking that names conform to a specified format.
031 *
032 * @author Rick Giles
033 */
034public abstract class AbstractNameCheck
035    extends AbstractCheck {
036    /**
037     * Message key for invalid pattern error.
038     */
039    public static final String MSG_INVALID_PATTERN = "name.invalidPattern";
040
041    /** The regexp to match against. */
042    private Pattern format;
043
044    /**
045     * Creates a new {@code AbstractNameCheck} instance.
046     * @param format format to check with
047     */
048    protected AbstractNameCheck(String format) {
049        this.format = CommonUtils.createPattern(format);
050    }
051
052    /**
053     * Decides whether the name of an AST should be checked against
054     * the format regexp.
055     * @param ast the AST to check.
056     * @return true if the IDENT subnode of ast should be checked against
057     *     the format regexp.
058     */
059    protected abstract boolean mustCheckName(DetailAST ast);
060
061    /**
062     * Set the format for the specified regular expression.
063     * @param pattern the new pattern
064     */
065    public final void setFormat(Pattern pattern) {
066        format = pattern;
067    }
068
069    @Override
070    public void visitToken(DetailAST ast) {
071        if (mustCheckName(ast)) {
072            final DetailAST nameAST = ast.findFirstToken(TokenTypes.IDENT);
073            if (!format.matcher(nameAST.getText()).find()) {
074                log(nameAST.getLineNo(),
075                    nameAST.getColumnNo(),
076                    MSG_INVALID_PATTERN,
077                    nameAST.getText(),
078                    format.pattern());
079            }
080        }
081    }
082}