author | briangoetz |
Wed, 18 Dec 2013 10:29:25 -0500 | |
changeset 22159 | 682da512ec17 |
parent 14260 | 727a84636f12 |
permissions | -rw-r--r-- |
10 | 1 |
/* |
14260 | 2 |
* Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved. |
10 | 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 |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
10 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
10 | 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 |
* |
|
5520 | 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. |
|
10 | 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 |
* |
|
14260 | 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> |
|
10 | 40 |
*/ |
41 |
public abstract class MethodFinder { |
|
42 |
||
43 |
abstract boolean isCorrectMethod(MethodDoc method); |
|
44 |
||
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 |
} |
|
62 |
||
63 |
public MethodDoc searchInterfaces(ClassDoc cd, MethodDoc method) { |
|
64 |
MethodDoc[] implementedMethods = (new ImplementedMethods(method, null)).build(); |
|
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
14260
diff
changeset
|
65 |
for (MethodDoc implementedMethod : implementedMethods) { |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
14260
diff
changeset
|
66 |
if (isCorrectMethod(implementedMethod)) { |
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
14260
diff
changeset
|
67 |
return implementedMethod; |
10 | 68 |
} |
69 |
} |
|
70 |
return null; |
|
71 |
} |
|
72 |
} |