View Javadoc
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.api;
21  
22  import static com.google.common.truth.Truth.assertWithMessage;
23  import static com.puppycrawl.tools.checkstyle.internal.utils.TestUtil.isUtilsClassHasPrivateConstructor;
24  
25  import org.junit.jupiter.api.Test;
26  
27  public class JavadocCommentsTokenTypesTest {
28  
29      @Test
30      public void testIsProperUtilsClass() throws ReflectiveOperationException {
31          assertWithMessage("Constructor is not private")
32                  .that(isUtilsClassHasPrivateConstructor(JavadocCommentsTokenTypes.class))
33                  .isTrue();
34      }
35  
36      @Test
37      public void testTokenValues() {
38          final String msg = "Please ensure that token values in `JavadocTokenTypes.java` have not"
39                  + " changed.";
40  
41          assertWithMessage(msg)
42                  .that(JavadocCommentsTokenTypes.JAVADOC_CONTENT)
43                  .isEqualTo(1);
44          assertWithMessage(msg)
45                  .that(JavadocCommentsTokenTypes.LEADING_ASTERISK)
46                  .isEqualTo(2);
47          assertWithMessage(msg)
48                  .that(JavadocCommentsTokenTypes.NEWLINE)
49                  .isEqualTo(3);
50          assertWithMessage(msg)
51                  .that(JavadocCommentsTokenTypes.TEXT)
52                  .isEqualTo(4);
53          assertWithMessage(msg)
54                  .that(JavadocCommentsTokenTypes.JAVADOC_INLINE_TAG)
55                  .isEqualTo(6);
56          assertWithMessage(msg)
57                  .that(JavadocCommentsTokenTypes.JAVADOC_INLINE_TAG_START)
58                  .isEqualTo(7);
59          assertWithMessage(msg)
60                  .that(JavadocCommentsTokenTypes.JAVADOC_INLINE_TAG_END)
61                  .isEqualTo(8);
62          assertWithMessage(msg)
63                  .that(JavadocCommentsTokenTypes.IDENTIFIER)
64                  .isEqualTo(11);
65          assertWithMessage(msg)
66                  .that(JavadocCommentsTokenTypes.HASH)
67                  .isEqualTo(12);
68          assertWithMessage(msg)
69                  .that(JavadocCommentsTokenTypes.LPAREN)
70                  .isEqualTo(13);
71          assertWithMessage(msg)
72                  .that(JavadocCommentsTokenTypes.RPAREN)
73                  .isEqualTo(14);
74          assertWithMessage(msg)
75                  .that(JavadocCommentsTokenTypes.COMMA)
76                  .isEqualTo(15);
77          assertWithMessage(msg)
78                  .that(JavadocCommentsTokenTypes.TAG_OPEN)
79                  .isEqualTo(21);
80          assertWithMessage(msg)
81                  .that(JavadocCommentsTokenTypes.TAG_CLOSE)
82                  .isEqualTo(22);
83          assertWithMessage(msg)
84                  .that(JavadocCommentsTokenTypes.TAG_SLASH_CLOSE)
85                  .isEqualTo(23);
86          assertWithMessage(msg)
87                  .that(JavadocCommentsTokenTypes.TAG_SLASH)
88                  .isEqualTo(24);
89          assertWithMessage(msg)
90                  .that(JavadocCommentsTokenTypes.EQUALS)
91                  .isEqualTo(25);
92          assertWithMessage(msg)
93                  .that(JavadocCommentsTokenTypes.TAG_NAME)
94                  .isEqualTo(26);
95          assertWithMessage(msg)
96                  .that(JavadocCommentsTokenTypes.ATTRIBUTE_VALUE)
97                  .isEqualTo(27);
98          assertWithMessage(msg)
99                  .that(JavadocCommentsTokenTypes.SLASH)
100                 .isEqualTo(28);
101         assertWithMessage(msg)
102                 .that(JavadocCommentsTokenTypes.PARAMETER_TYPE)
103                 .isEqualTo(29);
104         assertWithMessage(msg)
105                 .that(JavadocCommentsTokenTypes.LT)
106                 .isEqualTo(30);
107         assertWithMessage(msg)
108                 .that(JavadocCommentsTokenTypes.GT)
109                 .isEqualTo(31);
110         assertWithMessage(msg)
111                 .that(JavadocCommentsTokenTypes.EXTENDS)
112                 .isEqualTo(32);
113         assertWithMessage(msg)
114                 .that(JavadocCommentsTokenTypes.SUPER)
115                 .isEqualTo(33);
116         assertWithMessage(msg)
117                 .that(JavadocCommentsTokenTypes.QUESTION)
118                 .isEqualTo(34);
119         assertWithMessage(msg)
120                 .that(JavadocCommentsTokenTypes.FORMAT_SPECIFIER)
121                 .isEqualTo(36);
122         assertWithMessage(msg)
123                 .that(JavadocCommentsTokenTypes.INDEX_TERM)
124                 .isEqualTo(41);
125         assertWithMessage(msg)
126                 .that(JavadocCommentsTokenTypes.SNIPPET_ATTR_NAME)
127                 .isEqualTo(43);
128         assertWithMessage(msg)
129                 .that(JavadocCommentsTokenTypes.COLON)
130                 .isEqualTo(44);
131         assertWithMessage(msg)
132                 .that(JavadocCommentsTokenTypes.PARAMETER_NAME)
133                 .isEqualTo(47);
134         assertWithMessage(msg)
135                 .that(JavadocCommentsTokenTypes.STRING_LITERAL)
136                 .isEqualTo(51);
137         assertWithMessage(msg)
138                 .that(JavadocCommentsTokenTypes.FIELD_TYPE)
139                 .isEqualTo(56);
140         assertWithMessage(msg)
141                 .that(JavadocCommentsTokenTypes.AT_SIGN)
142                 .isEqualTo(57);
143         assertWithMessage(msg)
144                 .that(JavadocCommentsTokenTypes.TYPE_NAME)
145                 .isEqualTo(58);
146         assertWithMessage(msg)
147                 .that(JavadocCommentsTokenTypes.REFERENCE)
148                 .isEqualTo(59);
149         assertWithMessage(msg)
150                 .that(JavadocCommentsTokenTypes.MEMBER_REFERENCE)
151                 .isEqualTo(60);
152         assertWithMessage(msg)
153                 .that(JavadocCommentsTokenTypes.PARAMETER_TYPE_LIST)
154                 .isEqualTo(61);
155         assertWithMessage(msg)
156                 .that(JavadocCommentsTokenTypes.TYPE_ARGUMENTS)
157                 .isEqualTo(62);
158         assertWithMessage(msg)
159                 .that(JavadocCommentsTokenTypes.TYPE_ARGUMENT)
160                 .isEqualTo(63);
161         assertWithMessage(msg)
162                 .that(JavadocCommentsTokenTypes.DESCRIPTION)
163                 .isEqualTo(64);
164         assertWithMessage(msg)
165                 .that(JavadocCommentsTokenTypes.SNIPPET_ATTRIBUTES)
166                 .isEqualTo(65);
167         assertWithMessage(msg)
168                 .that(JavadocCommentsTokenTypes.SNIPPET_ATTRIBUTE)
169                 .isEqualTo(66);
170         assertWithMessage(msg)
171                 .that(JavadocCommentsTokenTypes.SNIPPET_BODY)
172                 .isEqualTo(67);
173         assertWithMessage(msg)
174                 .that(JavadocCommentsTokenTypes.HTML_ELEMENT)
175                 .isEqualTo(68);
176         assertWithMessage(msg)
177                 .that(JavadocCommentsTokenTypes.VOID_ELEMENT)
178                 .isEqualTo(69);
179         assertWithMessage(msg)
180                 .that(JavadocCommentsTokenTypes.HTML_CONTENT)
181                 .isEqualTo(70);
182         assertWithMessage(msg)
183                 .that(JavadocCommentsTokenTypes.HTML_TAG_START)
184                 .isEqualTo(71);
185         assertWithMessage(msg)
186                 .that(JavadocCommentsTokenTypes.HTML_TAG_END)
187                 .isEqualTo(72);
188         assertWithMessage(msg)
189                 .that(JavadocCommentsTokenTypes.HTML_ATTRIBUTES)
190                 .isEqualTo(73);
191         assertWithMessage(msg)
192                 .that(JavadocCommentsTokenTypes.HTML_ATTRIBUTE)
193                 .isEqualTo(74);
194         assertWithMessage(msg)
195                 .that(JavadocCommentsTokenTypes.JAVADOC_BLOCK_TAG)
196                 .isEqualTo(75);
197         assertWithMessage(msg)
198                 .that(JavadocCommentsTokenTypes.CODE_INLINE_TAG)
199                 .isEqualTo(76);
200         assertWithMessage(msg)
201                 .that(JavadocCommentsTokenTypes.LINK_INLINE_TAG)
202                 .isEqualTo(77);
203         assertWithMessage(msg)
204                 .that(JavadocCommentsTokenTypes.LINKPLAIN_INLINE_TAG)
205                 .isEqualTo(78);
206         assertWithMessage(msg)
207                 .that(JavadocCommentsTokenTypes.VALUE_INLINE_TAG)
208                 .isEqualTo(79);
209         assertWithMessage(msg)
210                 .that(JavadocCommentsTokenTypes.INHERIT_DOC_INLINE_TAG)
211                 .isEqualTo(80);
212         assertWithMessage(msg)
213                 .that(JavadocCommentsTokenTypes.SUMMARY_INLINE_TAG)
214                 .isEqualTo(81);
215         assertWithMessage(msg)
216                 .that(JavadocCommentsTokenTypes.SYSTEM_PROPERTY_INLINE_TAG)
217                 .isEqualTo(82);
218         assertWithMessage(msg)
219                 .that(JavadocCommentsTokenTypes.INDEX_INLINE_TAG)
220                 .isEqualTo(83);
221         assertWithMessage(msg)
222                 .that(JavadocCommentsTokenTypes.RETURN_INLINE_TAG)
223                 .isEqualTo(84);
224         assertWithMessage(msg)
225                 .that(JavadocCommentsTokenTypes.LITERAL_INLINE_TAG)
226                 .isEqualTo(85);
227         assertWithMessage(msg)
228                 .that(JavadocCommentsTokenTypes.SNIPPET_INLINE_TAG)
229                 .isEqualTo(86);
230         assertWithMessage(msg)
231                 .that(JavadocCommentsTokenTypes.CUSTOM_INLINE_TAG)
232                 .isEqualTo(87);
233         assertWithMessage(msg)
234                 .that(JavadocCommentsTokenTypes.AUTHOR_BLOCK_TAG)
235                 .isEqualTo(88);
236         assertWithMessage(msg)
237                 .that(JavadocCommentsTokenTypes.DEPRECATED_BLOCK_TAG)
238                 .isEqualTo(89);
239         assertWithMessage(msg)
240                 .that(JavadocCommentsTokenTypes.RETURN_BLOCK_TAG)
241                 .isEqualTo(90);
242         assertWithMessage(msg)
243                 .that(JavadocCommentsTokenTypes.PARAM_BLOCK_TAG)
244                 .isEqualTo(91);
245         assertWithMessage(msg)
246                 .that(JavadocCommentsTokenTypes.EXCEPTION_BLOCK_TAG)
247                 .isEqualTo(92);
248         assertWithMessage(msg)
249                 .that(JavadocCommentsTokenTypes.THROWS_BLOCK_TAG)
250                 .isEqualTo(93);
251         assertWithMessage(msg)
252                 .that(JavadocCommentsTokenTypes.SINCE_BLOCK_TAG)
253                 .isEqualTo(94);
254         assertWithMessage(msg)
255                 .that(JavadocCommentsTokenTypes.VERSION_BLOCK_TAG)
256                 .isEqualTo(95);
257         assertWithMessage(msg)
258                 .that(JavadocCommentsTokenTypes.SEE_BLOCK_TAG)
259                 .isEqualTo(96);
260         assertWithMessage(msg)
261                 .that(JavadocCommentsTokenTypes.HIDDEN_BLOCK_TAG)
262                 .isEqualTo(97);
263         assertWithMessage(msg)
264                 .that(JavadocCommentsTokenTypes.USES_BLOCK_TAG)
265                 .isEqualTo(98);
266         assertWithMessage(msg)
267                 .that(JavadocCommentsTokenTypes.PROVIDES_BLOCK_TAG)
268                 .isEqualTo(99);
269         assertWithMessage(msg)
270                 .that(JavadocCommentsTokenTypes.SERIAL_BLOCK_TAG)
271                 .isEqualTo(100);
272         assertWithMessage(msg)
273                 .that(JavadocCommentsTokenTypes.SERIAL_DATA_BLOCK_TAG)
274                 .isEqualTo(101);
275         assertWithMessage(msg)
276                 .that(JavadocCommentsTokenTypes.SERIAL_FIELD_BLOCK_TAG)
277                 .isEqualTo(102);
278         assertWithMessage(msg)
279                 .that(JavadocCommentsTokenTypes.CUSTOM_BLOCK_TAG)
280                 .isEqualTo(103);
281         assertWithMessage(msg)
282                 .that(JavadocCommentsTokenTypes.HTML_COMMENT_START)
283                 .isEqualTo(104);
284         assertWithMessage(msg)
285                 .that(JavadocCommentsTokenTypes.HTML_COMMENT_END)
286                 .isEqualTo(105);
287         assertWithMessage(msg)
288                 .that(JavadocCommentsTokenTypes.HTML_COMMENT)
289                 .isEqualTo(106);
290         assertWithMessage(msg)
291                 .that(JavadocCommentsTokenTypes.HTML_COMMENT_CONTENT)
292                 .isEqualTo(107);
293         assertWithMessage(msg)
294                 .that(JavadocCommentsTokenTypes.TAG_ATTR_NAME)
295                 .isEqualTo(114);
296     }
297 
298 }