1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2025 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle.grammar;
21
22 import java.util.Set;
23
24 import org.antlr.v4.runtime.TokenStream;
25
26 /**
27 * Utility class for Javadoc comments parser operations.
28 */
29 public final class JavadocCommentsParserUtil {
30
31 /**
32 * Private constructor to prevent instantiation of this utility class.
33 *
34 * @throws IllegalStateException if this constructor is called
35 */
36 private JavadocCommentsParserUtil() {
37 throw new IllegalStateException("Utility class");
38 }
39
40 /**
41 * Checks if the next token in the input stream is a non-tight tag.
42 *
43 * @param input the input token stream
44 * @param unclosedTagNameTokens a set of unclosed tag name tokens
45 * @return true if the next token is a non-tight tag, false otherwise
46 */
47 public static boolean isNonTightTag(
48 TokenStream input, Set<SimpleToken> unclosedTagNameTokens) {
49 final SimpleToken lookahead = SimpleToken.from(input.LT(2));
50 return unclosedTagNameTokens.contains(lookahead);
51 }
52 }