aoqi@0: /*
aoqi@0:  * Copyright (c) 1999, 2012, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.doclets.internal.toolkit.util;
aoqi@0: 
aoqi@0: import java.util.*;
aoqi@0: 
aoqi@0: import com.sun.javadoc.*;
aoqi@0: import com.sun.tools.doclets.internal.toolkit.Configuration;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * For a given class method, build an array of interface methods which it
aoqi@0:  * implements.
aoqi@0:  *
aoqi@0:  *  <p><b>This is NOT part of any supported API.
aoqi@0:  *  If you write code that depends on this, you do so at your own risk.
aoqi@0:  *  This code and its internal interfaces are subject to change or
aoqi@0:  *  deletion without notice.</b>
aoqi@0:  *
aoqi@0:  * @author Atul M Dambalkar
aoqi@0:  */
aoqi@0: public class ImplementedMethods {
aoqi@0: 
aoqi@0:     private Map<MethodDoc,Type> interfaces = new HashMap<MethodDoc,Type>();
aoqi@0:     private List<MethodDoc> methlist = new ArrayList<MethodDoc>();
aoqi@0:     private Configuration configuration;
aoqi@0:     private final ClassDoc classdoc;
aoqi@0:     private final MethodDoc method;
aoqi@0: 
aoqi@0:     public ImplementedMethods(MethodDoc method, Configuration configuration) {
aoqi@0:         this.method = method;
aoqi@0:         this.configuration = configuration;
aoqi@0:         classdoc = method.containingClass();
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Return the array of interface methods which the method passed in the
aoqi@0:      * constructor is implementing. The search/build order is as follows:
aoqi@0:      * <pre>
aoqi@0:      * 1. Search in all the immediate interfaces which this method's class is
aoqi@0:      *    implementing. Do it recursively for the superinterfaces as well.
aoqi@0:      * 2. Traverse all the superclasses and search recursively in the
aoqi@0:      *    interfaces which those superclasses implement.
aoqi@0:      *</pre>
aoqi@0:      *
aoqi@0:      * @return MethodDoc[] Array of implemented methods.
aoqi@0:      */
aoqi@0:     public MethodDoc[] build(boolean sort) {
aoqi@0:         buildImplementedMethodList(sort);
aoqi@0:         return methlist.toArray(new MethodDoc[methlist.size()]);
aoqi@0:     }
aoqi@0: 
aoqi@0:     public MethodDoc[] build() {
aoqi@0:         return build(true);
aoqi@0:     }
aoqi@0: 
aoqi@0:     public Type getMethodHolder(MethodDoc methodDoc) {
aoqi@0:         return interfaces.get(methodDoc);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Search for the method in the array of interfaces. If found check if it is
aoqi@0:      * overridden by any other subinterface method which this class
aoqi@0:      * implements. If it is not overidden, add it in the method list.
aoqi@0:      * Do this recursively for all the extended interfaces for each interface
aoqi@0:      * from the array passed.
aoqi@0:      */
aoqi@0:     private void buildImplementedMethodList(boolean sort) {
aoqi@0:         List<Type> intfacs = Util.getAllInterfaces(classdoc, configuration, sort);
aoqi@0:         for (Iterator<Type> iter = intfacs.iterator(); iter.hasNext(); ) {
aoqi@0:             Type interfaceType = iter.next();
aoqi@0:             MethodDoc found = Util.findMethod(interfaceType.asClassDoc(), method);
aoqi@0:             if (found != null) {
aoqi@0:                 removeOverriddenMethod(found);
aoqi@0:                 if (!overridingMethodFound(found)) {
aoqi@0:                     methlist.add(found);
aoqi@0:                     interfaces.put(found, interfaceType);
aoqi@0:                 }
aoqi@0:             }
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Search in the method list and check if it contains a method which
aoqi@0:      * is overridden by the method as parameter.  If found, remove the
aoqi@0:      * overridden method from the method list.
aoqi@0:      *
aoqi@0:      * @param method Is this method overriding a method in the method list.
aoqi@0:      */
aoqi@0:     private void removeOverriddenMethod(MethodDoc method) {
aoqi@0:         ClassDoc overriddenClass = method.overriddenClass();
aoqi@0:         if (overriddenClass != null) {
aoqi@0:             for (int i = 0; i < methlist.size(); i++) {
aoqi@0:                 ClassDoc cd = methlist.get(i).containingClass();
aoqi@0:                 if (cd == overriddenClass || overriddenClass.subclassOf(cd)) {
aoqi@0:                     methlist.remove(i);  // remove overridden method
aoqi@0:                     return;
aoqi@0:                 }
aoqi@0:             }
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Search in the already found methods' list and check if it contains
aoqi@0:      * a method which is overriding the method parameter or is the method
aoqi@0:      * parameter itself.
aoqi@0:      *
aoqi@0:      * @param method MethodDoc Method to be searched in the Method List for
aoqi@0:      * an overriding method.
aoqi@0:      */
aoqi@0:     private boolean overridingMethodFound(MethodDoc method) {
aoqi@0:         ClassDoc containingClass = method.containingClass();
aoqi@0:         for (int i = 0; i < methlist.size(); i++) {
aoqi@0:             MethodDoc listmethod = methlist.get(i);
aoqi@0:             if (containingClass == listmethod.containingClass()) {
aoqi@0:                 // it's the same method.
aoqi@0:                 return true;
aoqi@0:             }
aoqi@0:             ClassDoc cd = listmethod.overriddenClass();
aoqi@0:             if (cd == null) {
aoqi@0:                 continue;
aoqi@0:             }
aoqi@0:             if (cd == containingClass || cd.subclassOf(containingClass)) {
aoqi@0:                 return true;
aoqi@0:             }
aoqi@0:         }
aoqi@0:         return false;
aoqi@0:     }
aoqi@0: }