4141 */
4242public class DocFinder {
4343
44- public static final class DocTreeInfo {
45- public final DocTree docTree ;
46- public final Element element ;
47-
48- public DocTreeInfo () {
49- this .docTree = null ;
50- this .element = null ;
51- }
52-
53- public DocTreeInfo (DocTree docTree , Element baseElement ) {
54- this .docTree = docTree ;
55- this .element = baseElement ;
56- }
57-
58- @ Override
59- public String toString () {
60- return "DocTreeInfo{" + "docTree=" + docTree + ", element=" + element + '}' ;
61- }
62- }
44+ public record DocTreeInfo (DocTree docTree , Element element ) { }
6345
6446 /**
6547 * The class that encapsulates the input.
6648 */
6749 public static class Input {
50+
6851 /**
6952 * The element to search documentation from.
7053 */
7154 public Element element ;
55+
7256 /**
7357 * The taglet to search for documentation on behalf of. Null if we want
7458 * to search for overall documentation.
7559 */
76- public InheritableTaglet taglet = null ;
60+ public InheritableTaglet taglet ;
7761
7862 /**
7963 * The id of the tag to retrieve documentation for.
8064 */
81- public String tagId = null ;
65+ public String tagId ;
8266
8367 /**
8468 * The tag to retrieve documentation for. This is only used for the
85- * inheritDoc tag.
69+ * {@code {@ inheritDoc}} tag.
8670 */
8771 public final DocTreeInfo docTreeInfo ;
8872
8973 /**
9074 * True if we only want to search for the first sentence.
9175 */
92- public boolean isFirstSentence = false ;
76+ public boolean isFirstSentence ;
9377
9478 /**
95- * True if we are looking for documentation to replace the inheritDocTag .
79+ * True if we are looking for documentation to replace the {@code {@inheritDoc}} tag .
9680 */
97- public boolean isInheritDocTag = false ;
81+ public boolean isInheritDocTag ;
9882
9983 /**
10084 * Used to distinguish between type variable param tags and regular
10185 * param tags.
10286 */
103- public boolean isTypeVariableParamTag = false ;
87+ public boolean isTypeVariableParamTag ;
10488
10589 public final Utils utils ;
10690
107- public Input (Utils utils , Element element , InheritableTaglet taglet , DocTreeInfo dtInfo ,
108- boolean isFirstSentence , boolean isInheritDocTag ) {
109- this .utils = utils ;
110- this .element = element ;
111- this .taglet = taglet ;
112- this .isFirstSentence = isFirstSentence ;
113- this .isInheritDocTag = isInheritDocTag ;
114- this .docTreeInfo = dtInfo ;
115- }
116-
117- public Input (Utils utils , Element element , InheritableTaglet taglet , String tagId ) {
91+ public Input (Utils utils ,
92+ Element element ,
93+ InheritableTaglet taglet ,
94+ String tagId ) {
11895 this (utils , element );
11996 this .taglet = taglet ;
12097 this .tagId = tagId ;
12198 }
12299
123- public Input (Utils utils , Element element , InheritableTaglet taglet , String tagId ,
124- boolean isTypeVariableParamTag ) {
100+ public Input (Utils utils ,
101+ Element element ,
102+ InheritableTaglet taglet ,
103+ String tagId ,
104+ boolean isTypeVariableParamTag ) {
125105 this (utils , element );
126106 this .taglet = taglet ;
127107 this .tagId = tagId ;
@@ -134,32 +114,35 @@ public Input(Utils utils, Element element, InheritableTaglet taglet) {
134114 }
135115
136116 public Input (Utils utils , Element element ) {
137- if (element == null )
138- throw new NullPointerException ();
139- this .element = element ;
117+ this .element = Objects .requireNonNull (element );
140118 this .utils = utils ;
141- this .docTreeInfo = new DocTreeInfo ();
119+ this .docTreeInfo = new DocTreeInfo (null , null );
142120 }
143121
144- public Input (Utils utils , Element element , boolean isFirstSentence ) {
145- this (utils , element );
122+ public Input (Utils utils ,
123+ Element element ,
124+ InheritableTaglet taglet ,
125+ DocTreeInfo dtInfo ,
126+ boolean isFirstSentence ,
127+ boolean isInheritDocTag ) {
128+ this .utils = utils ;
129+ this .element = Objects .requireNonNull (element );
130+ this .taglet = taglet ;
146131 this .isFirstSentence = isFirstSentence ;
132+ this .isInheritDocTag = isInheritDocTag ;
133+ this .docTreeInfo = dtInfo ;
147134 }
148135
149- public Input copy (Utils utils ) {
150- if (this .element == null ) {
151- throw new NullPointerException ();
152- }
153- Input clone = new Input (utils , this .element , this .taglet , this .docTreeInfo ,
154- this .isFirstSentence , this .isInheritDocTag );
155- clone .tagId = this .tagId ;
156- clone .isTypeVariableParamTag = this .isTypeVariableParamTag ;
157- return clone ;
136+ private Input copy () {
137+ var copy = new Input (utils , element , taglet , docTreeInfo ,
138+ isFirstSentence , isInheritDocTag );
139+ copy .tagId = tagId ;
140+ copy .isTypeVariableParamTag = isTypeVariableParamTag ;
141+ return copy ;
158142 }
159143
160144 /**
161- * For debugging purposes
162- * @return string representation
145+ * For debugging purposes.
163146 */
164147 @ Override
165148 public String toString () {
@@ -178,14 +161,15 @@ public String toString() {
178161 * The class that encapsulates the output.
179162 */
180163 public static class Output {
164+
181165 /**
182166 * The tag that holds the documentation. Null if documentation
183167 * is not held by a tag.
184168 */
185169 public DocTree holderTag ;
186170
187171 /**
188- * The Doc object that holds the documentation.
172+ * The element that holds the documentation.
189173 */
190174 public Element holder ;
191175
@@ -200,18 +184,16 @@ public static class Output {
200184 public boolean isValidInheritDocTag = true ;
201185
202186 /**
203- * When automatically inheriting throws tags, you sometime must inherit
204- * more than one tag. For example if the element declares that it throws
205- * IOException and the overridden element has throws tags for IOException and
187+ * When automatically inheriting throws tags, you sometimes must inherit
188+ * more than one tag. For example, if a method declares that it throws
189+ * IOException and the overridden method has {@code @ throws} tags for IOException and
206190 * ZipException, both tags would be inherited because ZipException is a
207- * subclass of IOException. This subclass of DocFinder.Output allows
208- * multiple tag inheritance.
191+ * subclass of IOException. This allows multiple tag inheritance.
209192 */
210- public List <DocTree > tagList = new ArrayList <>();
193+ public final List <DocTree > tagList = new ArrayList <>();
211194
212195 /**
213- * Returns a string representation for debugging purposes
214- * @return string
196+ * For debugging purposes.
215197 */
216198 @ Override
217199 public String toString () {
@@ -226,9 +208,7 @@ public String toString() {
226208
227209 /**
228210 * Search for the requested comments in the given element. If it does not
229- * have comments, return documentation from the overridden element if possible.
230- * If the overridden element does not exist or does not have documentation to
231- * inherit, search for documentation to inherit from implemented methods.
211+ * have comments, return the inherited comments if possible.
232212 *
233213 * @param input the input object used to perform the search.
234214 *
@@ -250,14 +230,15 @@ public static Output search(BaseConfiguration configuration, Input input) {
250230 input .taglet .inherit (input , output );
251231 }
252232
253- if (output . inlineTags != null && !output .inlineTags .isEmpty ()) {
233+ if (!output .inlineTags .isEmpty ()) {
254234 return output ;
255235 }
256236 output .isValidInheritDocTag = false ;
257- Input inheritedSearchInput = input .copy (configuration . utils );
237+ Input inheritedSearchInput = input .copy ();
258238 inheritedSearchInput .isInheritDocTag = false ;
259239 if (utils .isMethod (input .element )) {
260- ExecutableElement overriddenMethod = utils .overriddenMethod ((ExecutableElement ) input .element );
240+ ExecutableElement m = (ExecutableElement ) input .element ;
241+ ExecutableElement overriddenMethod = utils .overriddenMethod (m );
261242 if (overriddenMethod != null ) {
262243 inheritedSearchInput .element = overriddenMethod ;
263244 output = search (configuration , inheritedSearchInput );
@@ -266,13 +247,9 @@ public static Output search(BaseConfiguration configuration, Input input) {
266247 return output ;
267248 }
268249 }
269- //NOTE: When we fix the bug where ClassDoc.interfaceTypes() does
270- // not pass all implemented interfaces, we will use the
271- // appropriate element here.
272250 TypeElement encl = utils .getEnclosingTypeElement (input .element );
273251 VisibleMemberTable vmt = configuration .getVisibleMemberTable (encl );
274- List <ExecutableElement > implementedMethods =
275- vmt .getImplementedMethods ((ExecutableElement )input .element );
252+ List <ExecutableElement > implementedMethods = vmt .getImplementedMethods (m );
276253 for (ExecutableElement implementedMethod : implementedMethods ) {
277254 inheritedSearchInput .element = implementedMethod ;
278255 output = search (configuration , inheritedSearchInput );
0 commit comments