01: /*
02: * Copyright 1999-2004 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25:
26: package com.sun.tools.doclets.internal.toolkit.util;
27:
28: import com.sun.javadoc.*;
29:
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: * This code is not part of an API.
37: * It is implementation that is subject to change.
38: * Do not use it as an API.
39: */
40: public abstract class MethodFinder {
41:
42: abstract boolean isCorrectMethod(MethodDoc method);
43:
44: public MethodDoc search(ClassDoc cd, MethodDoc method) {
45: MethodDoc meth = searchInterfaces(cd, method);
46: if (meth != null) {
47: return meth;
48: }
49: ClassDoc icd = cd.super class();
50: if (icd != null) {
51: meth = Util.findMethod(icd, method);
52: if (meth != null) {
53: if (isCorrectMethod(meth)) {
54: return meth;
55: }
56: }
57: return search(icd, method);
58: }
59: return null;
60: }
61:
62: public MethodDoc searchInterfaces(ClassDoc cd, MethodDoc method) {
63: MethodDoc[] implementedMethods = (new ImplementedMethods(
64: 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: }
|