Mon, 15 Oct 2012 17:07:55 -0700
8000666: javadoc should write directly to Writer instead of composing strings
Reviewed-by: bpatel
1 /*
2 * Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
26 package com.sun.tools.doclets.internal.toolkit.util;
28 import com.sun.javadoc.*;
30 /**
31 * This class is useful for searching a method which has documentation
32 * comment and documentation tags. The method is searched in all the
33 * superclasses and interfaces(subsequently super-interfaces also)
34 * recursively.
35 *
36 * <p><b>This is NOT part of any supported API.
37 * If you write code that depends on this, you do so at your own risk.
38 * This code and its internal interfaces are subject to change or
39 * deletion without notice.</b>
40 */
41 public abstract class MethodFinder {
43 abstract boolean isCorrectMethod(MethodDoc method);
45 public MethodDoc search(ClassDoc cd, MethodDoc method) {
46 MethodDoc meth = searchInterfaces(cd, method);
47 if (meth != null) {
48 return meth;
49 }
50 ClassDoc icd = cd.superclass();
51 if (icd != null) {
52 meth = Util.findMethod(icd, method);
53 if (meth != null) {
54 if (isCorrectMethod(meth)) {
55 return meth;
56 }
57 }
58 return search(icd, method);
59 }
60 return null;
61 }
63 public MethodDoc searchInterfaces(ClassDoc cd, MethodDoc method) {
64 MethodDoc[] implementedMethods = (new ImplementedMethods(method, null)).build();
65 for (int i = 0; i < implementedMethods.length; i++) {
66 if (isCorrectMethod(implementedMethods[i])) {
67 return implementedMethods[i];
68 }
69 }
70 return null;
71 }
72 }