001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2025 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 constant names conform to a specified pattern.
029 * A <em>constant</em> is a <strong>static</strong> and <strong>final</strong>
030 * field or an interface/annotation field, except
031 * <strong>serialVersionUID</strong> and <strong>serialPersistentFields
032 * </strong>.
033 * </div>
034 *
035 * @since 3.0
036 */
037public class ConstantNameCheck
038    extends AbstractAccessControlNameCheck {
039
040    /** Creates a new {@code ConstantNameCheck} instance. */
041    public ConstantNameCheck() {
042        super("^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$");
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 5.0
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 5.0
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 5.0
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 5.0
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        boolean returnValue = false;
107
108        final DetailAST modifiersAST =
109            ast.findFirstToken(TokenTypes.MODIFIERS);
110        final boolean isStaticFinal =
111            modifiersAST.findFirstToken(TokenTypes.LITERAL_STATIC) != null
112                && modifiersAST.findFirstToken(TokenTypes.FINAL) != null
113            || ScopeUtil.isInAnnotationBlock(ast)
114            || ScopeUtil.isInInterfaceBlock(ast);
115        if (isStaticFinal && shouldCheckInScope(modifiersAST)
116                        && !ScopeUtil.isInCodeBlock(ast)) {
117            // Handle the serialVersionUID and serialPersistentFields constants
118            // which are used for Serialization. Cannot enforce rules on it. :-)
119            final DetailAST nameAST = ast.findFirstToken(TokenTypes.IDENT);
120            if (!"serialVersionUID".equals(nameAST.getText())
121                && !"serialPersistentFields".equals(nameAST.getText())) {
122                returnValue = true;
123            }
124        }
125
126        return returnValue;
127    }
128
129}