001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2026 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 com.puppycrawl.tools.checkstyle.api.DetailAST;
023import com.puppycrawl.tools.checkstyle.api.TokenTypes;
024import com.puppycrawl.tools.checkstyle.utils.ScopeUtil;
025
026/**
027 * <div>
028 * Checks that instance variable names conform to a specified pattern.
029 * </div>
030 *
031 * @since 3.0
032 */
033public class MemberNameCheck extends AbstractAccessControlNameCheck {
034
035    /**
036     * A key is pointing to the warning message text in "messages.properties" file.
037     */
038    public static final String MSG_INVALID_PATTERN = "name.invalidPattern";
039
040    /** Creates a new {@code MemberNameCheck} instance. */
041    public MemberNameCheck() {
042        super("^[a-z][a-zA-Z0-9]*$", MSG_INVALID_PATTERN);
043    }
044
045    @Override
046    public int[] getDefaultTokens() {
047        return getRequiredTokens();
048    }
049
050    @Override
051    public int[] getAcceptableTokens() {
052        return getRequiredTokens();
053    }
054
055    @Override
056    public int[] getRequiredTokens() {
057        return new int[] {TokenTypes.VARIABLE_DEF};
058    }
059
060    /**
061     * Setter to control if check should apply to package-private members.
062     *
063     * @param applyTo new value of the property.
064     * @propertySince 3.4
065     */
066    @Override
067    public final void setApplyToPackage(boolean applyTo) {
068        super.setApplyToPackage(applyTo);
069    }
070
071    /**
072     * Setter to control if check should apply to private members.
073     *
074     * @param applyTo new value of the property.
075     * @propertySince 3.4
076     */
077    @Override
078    public final void setApplyToPrivate(boolean applyTo) {
079        super.setApplyToPrivate(applyTo);
080    }
081
082    /**
083     * Setter to control if check should apply to protected members.
084     *
085     * @param applyTo new value of the property.
086     * @propertySince 3.4
087     */
088    @Override
089    public final void setApplyToProtected(boolean applyTo) {
090        super.setApplyToProtected(applyTo);
091    }
092
093    /**
094     * Setter to control if check should apply to public members.
095     *
096     * @param applyTo new value of the property.
097     * @propertySince 3.4
098     */
099    @Override
100    public final void setApplyToPublic(boolean applyTo) {
101        super.setApplyToPublic(applyTo);
102    }
103
104    @Override
105    protected final boolean mustCheckName(DetailAST ast) {
106        final DetailAST modifiersAST =
107            ast.findFirstToken(TokenTypes.MODIFIERS);
108        final boolean isStatic = modifiersAST.findFirstToken(TokenTypes.LITERAL_STATIC) != null;
109
110        return !isStatic && !ScopeUtil.isInInterfaceOrAnnotationBlock(ast)
111            && !ScopeUtil.isLocalVariableDef(ast)
112                && shouldCheckInScope(modifiersAST);
113    }
114
115}