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
|
/*
* Copyright (C) 2010 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.doclava;
import com.google.clearsilver.jsilver.data.Data;
import java.util.ArrayList;
import java.util.LinkedHashSet;
import java.util.Set;
public abstract class DocInfo {
public DocInfo(String rawCommentText, SourcePositionInfo sp) {
mRawCommentText = rawCommentText;
mPosition = sp;
}
/**
* The relative path to a web page representing this item.
*/
public abstract String htmlPage();
/**
* @return true if the element has never been a part of public API
*/
public boolean isHidden() {
return comment().isHidden();
}
/**
* @return true if the element was once a part of public API, now removed.
*/
public boolean isRemoved() {
return comment().isRemoved();
}
/**
* Hidden and removed elements should not be appear in api.txt files, nor
* should they appear in the java doc.
* @return true if the element is either hidden or removed.
*/
public boolean isHiddenOrRemoved() {
return isHidden() || isRemoved();
}
public boolean isDocOnly() {
return comment().isDocOnly();
}
public String getRawCommentText() {
return mRawCommentText;
}
public void setRawCommentText(String rawCommentText) {
mRawCommentText = rawCommentText;
// so that if we've created one prior to changing, we recreate it
if (mComment != null) {
mComment = new Comment(mRawCommentText, parent(), mPosition);
}
}
public Comment comment() {
if (mComment == null) {
mComment = new Comment(mRawCommentText, parent(), mPosition);
}
return mComment;
}
public SourcePositionInfo position() {
return mPosition;
}
public void setPosition(SourcePositionInfo position) {
mPosition = position;
// so that if we've created one prior to changing, we recreate it
if (mComment != null) {
mComment = new Comment(mRawCommentText, parent(), mPosition);
}
}
public abstract ContainerInfo parent();
public void setSince(String since) {
mSince = since;
}
public String getSince() {
return mSince;
}
/**
* Sets the artifact in which the class resides.
* <p>
* This property should be specified as a full Maven dependency spec. For example, a Support
* Library core utility class may use "com.android.support:support-core-utils:26.0.1".
*
* @param artifact the artifact in which the class resides
* @return
*/
public void setArtifact(String artifact) {
mArtifact = artifact;
}
/**
* Returns the artifact in which the class resides.
*/
public String getArtifact() {
return mArtifact;
}
public void setDeprecatedSince(String since) {
mDeprecatedSince = since;
}
public String getDeprecatedSince() {
return mDeprecatedSince;
}
public boolean isDeprecated() {
return mDeprecatedSince != null ? true : false;
}
public final void addFederatedReference(FederatedSite source) {
mFederatedReferences.add(source);
}
public final Set<FederatedSite> getFederatedReferences() {
return mFederatedReferences;
}
public final void setFederatedReferences(Data data, String base) {
int pos = 0;
for (FederatedSite source : getFederatedReferences()) {
data.setValue(base + ".federated." + pos + ".url", source.linkFor(htmlPage()));
data.setValue(base + ".federated." + pos + ".name", source.name());
pos++;
}
}
private String mRawCommentText;
Comment mComment;
SourcePositionInfo mPosition;
private String mSince;
private String mArtifact;
private String mDeprecatedSince;
private Set<FederatedSite> mFederatedReferences = new LinkedHashSet<FederatedSite>();
}
|
