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.javadoc;
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.JavadocUtil;
027
028/**
029 * <div>
030 * Checks that the Javadoc closing delimiter contains exactly one asterisk before
031 * the slash.
032 * </div>
033 *
034 * <p>
035 * The closing delimiter of a Javadoc comment is {@code *}{@code /}. This check reports
036 * Javadoc comments whose closing delimiter is preceded by another asterisk, such as
037 * {@code **}{@code /} or {@code ***}{@code /}.
038 * </p>
039 *
040 * @since 14.1.0
041 */
042@StatelessCheck
043public class JavadocEndCommentDelimiterCheck extends AbstractCheck {
044
045    /**
046     * A key is pointing to the warning message text in "messages.properties" file.
047     */
048    public static final String MSG_KEY = "javadoc.end.delimiter";
049
050    /**
051     * Creates a new {@code JavadocEndCommentDelimiterCheck} instance.
052     */
053    public JavadocEndCommentDelimiterCheck() {
054        // no code by default
055    }
056
057    @Override
058    public int[] getDefaultTokens() {
059        return getRequiredTokens();
060    }
061
062    @Override
063    public int[] getAcceptableTokens() {
064        return getRequiredTokens();
065    }
066
067    @Override
068    public int[] getRequiredTokens() {
069        return new int[] {
070            TokenTypes.BLOCK_COMMENT_BEGIN,
071        };
072    }
073
074    @Override
075    public boolean isCommentNodesRequired() {
076        return true;
077    }
078
079    @Override
080    public void visitToken(DetailAST ast) {
081        if (JavadocUtil.isJavadocComment(ast)) {
082            final String commentContent = JavadocUtil.getBlockCommentContent(ast);
083
084            if (commentContent.endsWith("*")) {
085                log(ast.getLastChild(), MSG_KEY);
086            }
087        }
088    }
089
090}