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
|
/*
* Copyright (C) 2007-2010 Júlio Vilmar Gesser.
* Copyright (C) 2011, 2013-2017 The JavaParser Team.
*
* This file is part of JavaParser.
*
* JavaParser can be used either under the terms of
* a) the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* b) the terms of the Apache License
*
* You should have received a copy of both licenses in LICENCE.LGPL and
* LICENCE.APACHE. Please refer to those files for details.
*
* JavaParser 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.
*/
package com.github.javaparser.javadoc.description;
import static com.github.javaparser.utils.Utils.nextWord;
import static com.github.javaparser.utils.Utils.screamingToCamelCase;
/**
* An inline tag contained in a Javadoc description.
* <p>
* For example <code>{@link String}</code>
*/
public class JavadocInlineTag implements JavadocDescriptionElement {
public static JavadocDescriptionElement fromText(String text) {
if (!text.startsWith("{@")) {
throw new IllegalArgumentException(String.format("Expected to start with '{@'. Text '%s'", text));
}
if (!text.endsWith("}")) {
throw new IllegalArgumentException(String.format("Expected to end with '}'. Text '%s'", text));
}
text = text.substring(2, text.length() - 1);
String tagName = nextWord(text);
Type type = Type.fromName(tagName);
String content = text.substring(tagName.length());
return new JavadocInlineTag(tagName, type, content);
}
/**
* The type of tag: it could either correspond to a known tag (code, docRoot, etc.) or represent
* an unknown tag.
*/
public enum Type {
CODE,
DOC_ROOT,
INHERIT_DOC,
LINK,
LINKPLAIN,
LITERAL,
VALUE,
UNKNOWN;
Type() {
this.keyword = screamingToCamelCase(name());
}
private String keyword;
static JavadocInlineTag.Type fromName(String tagName) {
for (JavadocInlineTag.Type t : JavadocInlineTag.Type.values()) {
if (t.keyword.equals(tagName)) {
return t;
}
}
return UNKNOWN;
}
}
private String tagName;
private Type type;
private String content;
public JavadocInlineTag(String tagName, Type type, String content) {
this.tagName = tagName;
this.type = type;
this.content = content;
}
@Override
public String toText() {
return "@" + tagName + this.content;
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
JavadocInlineTag that = (JavadocInlineTag) o;
if (tagName != null ? !tagName.equals(that.tagName) : that.tagName != null) return false;
if (type != that.type) return false;
return content != null ? content.equals(that.content) : that.content == null;
}
@Override
public int hashCode() {
int result = tagName != null ? tagName.hashCode() : 0;
result = 31 * result + (type != null ? type.hashCode() : 0);
result = 31 * result + (content != null ? content.hashCode() : 0);
return result;
}
@Override
public String toString() {
return "JavadocInlineTag{" +
"tagName='" + tagName + '\'' +
", type=" + type +
", content='" + content + '\'' +
'}';
}
}
|
