1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2017 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.javadoc.utils;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import static org.junit.Assert.fail;
import java.util.List;
import org.junit.Test;
import com.puppycrawl.tools.checkstyle.internal.utils.TestUtil;
public class InlineTagUtilsTest {
@Test
public void testHasPrivateConstructor() throws Exception {
assertTrue("Constructor is not private",
TestUtil.isUtilsClassHasPrivateConstructor(InlineTagUtils.class, true));
}
@Test
public void testExtractInlineTags() {
final String[] text = {
"/** @see elsewhere ",
" * {@link List }, {@link List link text }",
" {@link List#add(Object) link text}",
" * {@link Class link text}",
" */"};
final List<TagInfo> tags = InlineTagUtils.extractInlineTags(text);
assertEquals("Unexpected tags size", 4, tags.size());
assertTag(tags.get(0), "link", "List", 2, 4);
assertTag(tags.get(1), "link", "List link text", 2, 19);
assertTag(tags.get(2), "link", "List#add(Object) link text", 3, 4);
assertTag(tags.get(3), "link", "Class link text", 4, 4);
}
@Test
public void testMultiLineLinkTag() {
final String[] text = {
"/**",
" * {@link foo",
" * bar baz}",
" */"};
final List<TagInfo> tags = InlineTagUtils.extractInlineTags(text);
assertEquals("Unexpected tags size", 1, tags.size());
assertTag(tags.get(0), "link", "foo bar baz", 2, 4);
}
@Test
public void testCollapseWhitespace() {
final String[] text = {
"/**",
" * {@code foo\t\t bar baz\t }",
" */"};
final List<TagInfo> tags = InlineTagUtils.extractInlineTags(text);
assertEquals("Unexpected tags size", 1, tags.size());
assertTag(tags.get(0), "code", "foo bar baz", 2, 4);
}
@Test
public void extractInlineTags() {
final String[] source = {
" {@link foo}",
};
final List<TagInfo> tags = InlineTagUtils.extractInlineTags(source);
assertEquals("Unexpected tags size", 1, tags.size());
final TagInfo tag = tags.get(0);
assertTag(tag, "link", "foo", 1, 3);
}
@Test
public void testBadInputExtractInlineTagsLineFeed() {
try {
InlineTagUtils.extractInlineTags("abc\ndef");
fail("IllegalArgumentException expected");
}
catch (IllegalArgumentException ex) {
assertTrue("Unexpected error message", ex.getMessage().contains("newline"));
}
}
@Test
public void testBadInputExtractInlineTagsCarriageReturn() {
try {
InlineTagUtils.extractInlineTags("abc\rdef");
fail("IllegalArgumentException expected");
}
catch (IllegalArgumentException ex) {
assertTrue("Invalid error message", ex.getMessage().contains("newline"));
}
}
private static void assertTag(TagInfo tag, String name, String value, int line, int col) {
assertEquals("Unexpected tags name", name, tag.getName());
assertEquals("Unexpected tags value", value, tag.getValue());
assertEquals("Unexpected tags position", line, tag.getPosition().getLine());
assertEquals("Unexpected tags position", col, tag.getPosition().getColumn());
}
}
|
