src/share/classes/com/sun/tools/doclets/internal/toolkit/util/MethodFinder.java

Mon, 02 May 2011 02:13:02 -0700

author
bpatel
date
Mon, 02 May 2011 02:13:02 -0700
changeset 995
62bc3775d5bb
parent 554
9d9f26857129
child 1359
25e14ad23cef
permissions
-rw-r--r--

6492694: @deprecated tag doesn't work in package-info files.
Reviewed-by: jjg

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

mercurial