Mon, 02 May 2011 02:13:02 -0700
6492694: @deprecated tag doesn't work in package-info files.
Reviewed-by: jjg
1 /*
2 * Copyright (c) 1999, 2004, 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 * 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 {
42 abstract boolean isCorrectMethod(MethodDoc method);
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.superclass();
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 }
62 public MethodDoc searchInterfaces(ClassDoc cd, MethodDoc method) {
63 MethodDoc[] implementedMethods = (new ImplementedMethods(method, null)).build();
64 for (int i = 0; i < implementedMethods.length; i++) {
65 if (isCorrectMethod(implementedMethods[i])) {
66 return implementedMethods[i];
67 }
68 }
69 return null;
70 }
71 }