-
-
Notifications
You must be signed in to change notification settings - Fork 342
/
JavadocInlineTag.java
163 lines (142 loc) · 4.09 KB
/
JavadocInlineTag.java
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/*
* SPDX-License-Identifier: (MIT OR CECILL-C)
*
* Copyright (C) 2006-2023 INRIA and contributors
*
* Spoon is available either under the terms of the MIT License (see LICENSE-MIT.txt) or the Cecill-C License (see LICENSE-CECILL-C.txt). You as the user are entitled to choose the terms under which to adopt Spoon.
*/
/**
* This file originally comes from JavaParser and is distributed 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
*/
package spoon.javadoc.internal;
import java.io.Serializable;
/**
* An inline tag contained in a Javadoc description.
*
* <p>For example <code>{@link String}</code>
* @deprecated Use the new javadoc parser submodule, see <a href="https://spoon.gforge.inria.fr/spoon_javadoc.html">Javadoc Parser</a>.
*/
@Deprecated(forRemoval = true, since = "11.0.0")
public class JavadocInlineTag implements JavadocDescriptionElement, Serializable {
private static final long serialVersionUID = 1L;
/** Return the next word of the string, in other words it stops when a space is encountered. */
public static String nextWord(String string) {
int index = 0;
while (index < string.length() && !Character.isWhitespace(string.charAt(index))) {
index++;
}
return string.substring(0, index);
}
/** parses a Javadoc tag */
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()).trim();
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.
*
* See also:
* <a href="https://docs.oracle.com/en/java/javase/17/docs/specs/javadoc/doc-comment-spec.html">
* Tags in the Javadoc specification
* </a>
*/
public enum Type {
CODE("code"),
DOC_ROOT("docRoot"),
INHERIT_DOC("inheritDoc"),
LINK("link"),
LINKPLAIN("linkplain"),
LITERAL("literal"),
VALUE("value"),
UNKNOWN("unknown");
private final String keyword;
Type(String keyword) {
this.keyword = keyword;
}
static Type fromName(String tagName) {
for (Type type : values()) {
if (type.keyword.equalsIgnoreCase(tagName)) {
return type;
}
}
return UNKNOWN;
}
}
private String tagName;
private Type type;
public void setContent(String content) {
this.content = content;
}
private String content;
public JavadocInlineTag(String tagName, Type type, String content) {
this.tagName = tagName;
this.type = type;
this.content = content;
}
public Type getType() {
return type;
}
public String getContent() {
return content;
}
public String getName() {
return tagName;
}
@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
+ '\''
+ '}';
}
}