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.naming; 021 022import org.apache.commons.lang3.ArrayUtils; 023 024import com.puppycrawl.tools.checkstyle.api.DetailAST; 025import com.puppycrawl.tools.checkstyle.api.TokenTypes; 026import com.puppycrawl.tools.checkstyle.utils.ScopeUtils; 027 028/** 029 * <p> 030 * Checks that local final variable names conform to a format specified 031 * by the format property. A catch parameter is considered to be 032 * a local variable.The format is a 033 * {@link java.util.regex.Pattern regular expression} and defaults to 034 * <strong>^[a-z][a-zA-Z0-9]*$</strong>. 035 * </p> 036 * <p> 037 * An example of how to configure the check is: 038 * </p> 039 * <pre> 040 * <module name="LocalFinalVariableName"/> 041 * </pre> 042 * <p> 043 * An example of how to configure the check for names that are only upper case 044 * letters and digits is: 045 * </p> 046 * <pre> 047 * <module name="LocalFinalVariableName"> 048 * <property name="format" value="^[A-Z][A-Z0-9]*$"/> 049 * </module> 050 * </pre> 051 * 052 * @author Rick Giles 053 */ 054public class LocalFinalVariableNameCheck 055 extends AbstractNameCheck { 056 /** Creates a new {@code LocalFinalVariableNameCheck} instance. */ 057 public LocalFinalVariableNameCheck() { 058 super("^[a-z][a-zA-Z0-9]*$"); 059 } 060 061 @Override 062 public int[] getDefaultTokens() { 063 return getAcceptableTokens(); 064 } 065 066 @Override 067 public int[] getAcceptableTokens() { 068 return new int[] { 069 TokenTypes.VARIABLE_DEF, 070 TokenTypes.PARAMETER_DEF, 071 }; 072 } 073 074 @Override 075 public int[] getRequiredTokens() { 076 return ArrayUtils.EMPTY_INT_ARRAY; 077 } 078 079 @Override 080 protected final boolean mustCheckName(DetailAST ast) { 081 final DetailAST modifiersAST = 082 ast.findFirstToken(TokenTypes.MODIFIERS); 083 final boolean isFinal = modifiersAST.branchContains(TokenTypes.FINAL); 084 return isFinal && ScopeUtils.isLocalVariableDef(ast); 085 } 086}