001//////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code for adherence to a set of rules. 003// Copyright (C) 2001-2016 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 format string of the regexp. */ 042 private String format; 043 044 /** The regexp to match against. */ 045 private Pattern regexp; 046 047 /** 048 * Creates a new {@code AbstractNameCheck} instance. 049 * @param format format to check with 050 */ 051 protected AbstractNameCheck(String format) { 052 setFormat(format); 053 } 054 055 /** 056 * Decides whether the name of an AST should be checked against 057 * the format regexp. 058 * @param ast the AST to check. 059 * @return true if the IDENT subnode of ast should be checked against 060 * the format regexp. 061 */ 062 protected abstract boolean mustCheckName(DetailAST ast); 063 064 /** 065 * Set the format to the specified regular expression. 066 * @param format a {@code String} value 067 * @throws org.apache.commons.beanutils.ConversionException unable to parse format 068 */ 069 public final void setFormat(String format) { 070 this.format = format; 071 regexp = CommonUtils.createPattern(format); 072 } 073 074 @Override 075 public void visitToken(DetailAST ast) { 076 if (mustCheckName(ast)) { 077 final DetailAST nameAST = ast.findFirstToken(TokenTypes.IDENT); 078 if (!regexp.matcher(nameAST.getText()).find()) { 079 log(nameAST.getLineNo(), 080 nameAST.getColumnNo(), 081 MSG_INVALID_PATTERN, 082 nameAST.getText(), 083 format); 084 } 085 } 086 } 087}