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.grammar;
021
022import java.util.Set;
023
024import org.antlr.v4.runtime.TokenStream;
025
026/**
027 * Utility class for Javadoc comments parser operations.
028 */
029public final class JavadocCommentsParserUtil {
030
031    /**
032     * Private constructor to prevent instantiation of this utility class.
033     *
034     * @throws IllegalStateException if this constructor is called
035     */
036    private JavadocCommentsParserUtil() {
037        throw new IllegalStateException("Utility class");
038    }
039
040    /**
041     * Checks if the next token in the input stream is a non-tight tag.
042     *
043     * @param input the input token stream
044     * @param unclosedTagNameTokens a set of unclosed tag name tokens
045     * @return true if the next token is a non-tight tag, false otherwise
046     */
047    public static boolean isNonTightTag(
048            TokenStream input, Set<SimpleToken> unclosedTagNameTokens) {
049        final SimpleToken lookahead = SimpleToken.from(input.LT(2));
050        return unclosedTagNameTokens.contains(lookahead);
051    }
052}