001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2020 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;
021
022import com.puppycrawl.tools.checkstyle.StatelessCheck;
023import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
024import com.puppycrawl.tools.checkstyle.api.DetailAST;
025import com.puppycrawl.tools.checkstyle.api.TokenTypes;
026import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
027
028/**
029 * <p>
030 * Checks that long constants are defined with an upper ell. That is {@code 'L'}
031 * and not {@code 'l'}. This is in accordance with the Java Language Specification,
032 * <a href="https://docs.oracle.com/javase/specs/jls/se11/html/jls-3.html#jls-3.10.1">
033 * Section 3.10.1</a>.
034 * </p>
035 * <p>
036 * Rationale: The lower-case ell {@code 'l'} looks a lot like {@code 1}.
037 * </p>
038 * <p>
039 * To configure the check:
040 * </p>
041 * <pre>
042 * &lt;module name=&quot;UpperEll&quot;/&gt;
043 * </pre>
044 * <pre>
045 * class Test {
046 *   long var1 = 508987; // OK
047 *   long var2 = 508987l; // violation
048 *   long var3 = 508987L; // OK
049 * }
050 * </pre>
051 * <p>
052 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
053 * </p>
054 * <p>
055 * Violation Message Keys:
056 * </p>
057 * <ul>
058 * <li>
059 * {@code upperEll}
060 * </li>
061 * </ul>
062 *
063 * @since 3.0
064 */
065@StatelessCheck
066public class UpperEllCheck extends AbstractCheck {
067
068    /**
069     * A key is pointing to the warning message text in "messages.properties"
070     * file.
071     */
072    public static final String MSG_KEY = "upperEll";
073
074    @Override
075    public int[] getDefaultTokens() {
076        return getRequiredTokens();
077    }
078
079    @Override
080    public int[] getAcceptableTokens() {
081        return getRequiredTokens();
082    }
083
084    @Override
085    public int[] getRequiredTokens() {
086        return new int[] {TokenTypes.NUM_LONG};
087    }
088
089    @Override
090    public void visitToken(DetailAST ast) {
091        if (CommonUtil.endsWithChar(ast.getText(), 'l')) {
092            log(ast, MSG_KEY);
093        }
094    }
095
096}