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

Mon, 15 Oct 2012 17:07:55 -0700

author
jjg
date
Mon, 15 Oct 2012 17:07:55 -0700
changeset 1364
8db45b13526e
parent 1359
25e14ad23cef
child 2525
2eb010b6cb22
permissions
-rw-r--r--

8000666: javadoc should write directly to Writer instead of composing strings
Reviewed-by: bpatel

duke@1 1 /*
jjg@1359 2 * Copyright (c) 1999, 2012, 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 *
jjg@1359 36 * <p><b>This is NOT part of any supported API.
jjg@1359 37 * If you write code that depends on this, you do so at your own risk.
jjg@1359 38 * This code and its internal interfaces are subject to change or
jjg@1359 39 * deletion without notice.</b>
duke@1 40 */
duke@1 41 public abstract class MethodFinder {
duke@1 42
duke@1 43 abstract boolean isCorrectMethod(MethodDoc method);
duke@1 44
duke@1 45 public MethodDoc search(ClassDoc cd, MethodDoc method) {
duke@1 46 MethodDoc meth = searchInterfaces(cd, method);
duke@1 47 if (meth != null) {
duke@1 48 return meth;
duke@1 49 }
duke@1 50 ClassDoc icd = cd.superclass();
duke@1 51 if (icd != null) {
duke@1 52 meth = Util.findMethod(icd, method);
duke@1 53 if (meth != null) {
duke@1 54 if (isCorrectMethod(meth)) {
duke@1 55 return meth;
duke@1 56 }
duke@1 57 }
duke@1 58 return search(icd, method);
duke@1 59 }
duke@1 60 return null;
duke@1 61 }
duke@1 62
duke@1 63 public MethodDoc searchInterfaces(ClassDoc cd, MethodDoc method) {
duke@1 64 MethodDoc[] implementedMethods = (new ImplementedMethods(method, null)).build();
duke@1 65 for (int i = 0; i < implementedMethods.length; i++) {
duke@1 66 if (isCorrectMethod(implementedMethods[i])) {
duke@1 67 return implementedMethods[i];
duke@1 68 }
duke@1 69 }
duke@1 70 return null;
duke@1 71 }
duke@1 72 }

mercurial