////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2017 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.naming;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
import com.puppycrawl.tools.checkstyle.utils.ScopeUtils;
/**
* <p>
* Checks that local final variable names conform to a format specified
* by the format property. A catch parameter and resources in try statements
* are considered to be a local variables.The format is a
* {@link java.util.regex.Pattern regular expression} and defaults to
* <strong>^[a-z][a-zA-Z0-9]*$</strong>.
* </p>
* <p>
* An example of how to configure the check is:
* </p>
* <pre>
* <module name="LocalFinalVariableName"/>
* </pre>
* <p>
* An example of how to configure the check for names that are only upper case
* letters and digits is:
* </p>
* <pre>
* <module name="LocalFinalVariableName">
* <property name="format" value="^[A-Z][A-Z0-9]*$"/>
* </module>
* </pre>
*
* @author Rick Giles
*/
public class LocalFinalVariableNameCheck
extends AbstractNameCheck {
/** Creates a new {@code LocalFinalVariableNameCheck} instance. */
public LocalFinalVariableNameCheck() {
super("^[a-z][a-zA-Z0-9]*$");
}
@Override
public int[] getDefaultTokens() {
return getAcceptableTokens();
}
@Override
public int[] getAcceptableTokens() {
return new int[] {
TokenTypes.VARIABLE_DEF,
TokenTypes.PARAMETER_DEF,
TokenTypes.RESOURCE,
};
}
@Override
public int[] getRequiredTokens() {
return CommonUtils.EMPTY_INT_ARRAY;
}
@Override
protected final boolean mustCheckName(DetailAST ast) {
final DetailAST modifiersAST =
ast.findFirstToken(TokenTypes.MODIFIERS);
final boolean isFinal = ast.getType() == TokenTypes.RESOURCE
|| modifiersAST.branchContains(TokenTypes.FINAL);
return isFinal && ScopeUtils.isLocalVariableDef(ast);
}
}