duke@1: /*
ohair@554:  * Copyright (c) 1997, 2006, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.javadoc;
duke@1: 
duke@1: import com.sun.javadoc.*;
duke@1: 
duke@1: import com.sun.tools.javac.code.*;
duke@1: import com.sun.tools.javac.code.Symbol.*;
duke@1: import com.sun.tools.javac.code.Type;
duke@1: import com.sun.tools.javac.code.TypeTags;
duke@1: import com.sun.tools.javac.tree.JCTree.JCMethodDecl;
duke@1: import com.sun.tools.javac.util.Position;
duke@1: 
duke@1: import java.lang.reflect.Modifier;
duke@1: 
duke@1: /**
duke@1:  * Represents a method of a java class.
duke@1:  *
duke@1:  * @since 1.2
duke@1:  * @author Robert Field
duke@1:  * @author Neal Gafter (rewrite)
duke@1:  */
duke@1: 
duke@1: public class MethodDocImpl
duke@1:         extends ExecutableMemberDocImpl implements MethodDoc {
duke@1: 
duke@1:     /**
duke@1:      * constructor.
duke@1:      */
duke@1:     public MethodDocImpl(DocEnv env, MethodSymbol sym) {
duke@1:         super(env, sym);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * constructor.
duke@1:      */
duke@1:     public MethodDocImpl(DocEnv env, MethodSymbol sym,
duke@1:                          String docComment, JCMethodDecl tree, Position.LineMap lineMap) {
duke@1:         super(env, sym, docComment, tree, lineMap);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if it is a method, which it is.
duke@1:      * Note: constructors are not methods.
duke@1:      * This method is overridden by AnnotationTypeElementDocImpl.
duke@1:      *
duke@1:      * @return true
duke@1:      */
duke@1:     public boolean isMethod() {
duke@1:         return true;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if this method is abstract
duke@1:      */
duke@1:     public boolean isAbstract() {
duke@1:         //### This is dubious, but old 'javadoc' apparently does it.
duke@1:         //### I regard this as a bug and an obstacle to treating the
duke@1:         //### doclet API as a proper compile-time reflection facility.
duke@1:         //### (maddox 09/26/2000)
duke@1:         if (containingClass().isInterface()) {
duke@1:             //### Don't force creation of ClassDocImpl for super here.
duke@1:             // Abstract modifier is implicit.  Strip/canonicalize it.
duke@1:             return false;
duke@1:         }
duke@1:         return Modifier.isAbstract(getModifiers());
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Get return type.
duke@1:      *
duke@1:      * @return the return type of this method, null if it
duke@1:      * is a constructor.
duke@1:      */
duke@1:     public com.sun.javadoc.Type returnType() {
duke@1:         return TypeMaker.getType(env, sym.type.getReturnType(), false);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the class that originally defined the method that
duke@1:      * is overridden by the current definition, or null if no
duke@1:      * such class exists.
duke@1:      *
duke@1:      * @return a ClassDocImpl representing the superclass that
duke@1:      * originally defined this method, null if this method does
duke@1:      * not override a definition in a superclass.
duke@1:      */
duke@1:     public ClassDoc overriddenClass() {
duke@1:         com.sun.javadoc.Type t = overriddenType();
duke@1:         return (t != null) ? t.asClassDoc() : null;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the type containing the method that this method overrides.
duke@1:      * It may be a <code>ClassDoc</code> or a <code>ParameterizedType</code>.
duke@1:      */
duke@1:     public com.sun.javadoc.Type overriddenType() {
duke@1: 
duke@1:         if ((sym.flags() & Flags.STATIC) != 0) {
duke@1:             return null;
duke@1:         }
duke@1: 
duke@1:         ClassSymbol origin = (ClassSymbol)sym.owner;
duke@1:         for (Type t = env.types.supertype(origin.type);
duke@1:              t.tag == TypeTags.CLASS;
duke@1:              t = env.types.supertype(t)) {
duke@1:             ClassSymbol c = (ClassSymbol)t.tsym;
duke@1:             for (Scope.Entry e = c.members().lookup(sym.name); e.scope != null; e = e.next()) {
duke@1:                 if (sym.overrides(e.sym, origin, env.types, true)) {
duke@1:                     return TypeMaker.getType(env, t);
duke@1:                 }
duke@1:             }
duke@1:         }
duke@1:         return null;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return the method that this method overrides.
duke@1:      *
duke@1:      * @return a MethodDoc representing a method definition
duke@1:      * in a superclass this method overrides, null if
duke@1:      * this method does not override.
duke@1:      */
duke@1:     public MethodDoc overriddenMethod() {
duke@1: 
duke@1:         // Real overriding only.  Static members are simply hidden.
duke@1:         // Likewise for constructors, but the MethodSymbol.overrides
duke@1:         // method takes this into account.
duke@1:         if ((sym.flags() & Flags.STATIC) != 0) {
duke@1:             return null;
duke@1:         }
duke@1: 
duke@1:         // Derived from  com.sun.tools.javac.comp.Check.checkOverride .
duke@1: 
duke@1:         ClassSymbol origin = (ClassSymbol)sym.owner;
duke@1:         for (Type t = env.types.supertype(origin.type);
duke@1:              t.tag == TypeTags.CLASS;
duke@1:              t = env.types.supertype(t)) {
duke@1:             ClassSymbol c = (ClassSymbol)t.tsym;
duke@1:             for (Scope.Entry e = c.members().lookup(sym.name); e.scope != null; e = e.next()) {
duke@1:                 if (sym.overrides(e.sym, origin, env.types, true)) {
duke@1:                     return env.getMethodDoc((MethodSymbol)e.sym);
duke@1:                 }
duke@1:             }
duke@1:         }
duke@1:         return null;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Tests whether this method overrides another.
duke@1:      * The overridden method may be one declared in a superclass or
duke@1:      * a superinterface (unlike {@link #overriddenMethod()}).
duke@1:      *
duke@1:      * <p> When a non-abstract method overrides an abstract one, it is
duke@1:      * also said to <i>implement</i> the other.
duke@1:      *
duke@1:      * @param meth  the other method to examine
duke@1:      * @return <tt>true</tt> if this method overrides the other
duke@1:      */
duke@1:     public boolean overrides(MethodDoc meth) {
duke@1:         MethodSymbol overridee = ((MethodDocImpl) meth).sym;
duke@1:         ClassSymbol origin = (ClassSymbol) sym.owner;
duke@1: 
duke@1:         return sym.name == overridee.name &&
duke@1: 
duke@1:                // not reflexive as per JLS
duke@1:                sym != overridee &&
duke@1: 
duke@1:                // we don't care if overridee is static, though that wouldn't
duke@1:                // compile
duke@1:                !sym.isStatic() &&
duke@1: 
duke@1:                // sym, whose declaring type is the origin, must be
duke@1:                // in a subtype of overridee's type
duke@1:                env.types.asSuper(origin.type, overridee.owner) != null &&
duke@1: 
duke@1:                // check access and signatures; don't check return types
duke@1:                sym.overrides(overridee, origin, env.types, false);
duke@1:     }
duke@1: 
duke@1: 
duke@1:     public String name() {
duke@1:         return sym.name.toString();
duke@1:     }
duke@1: 
duke@1:     public String qualifiedName() {
duke@1:         return sym.enclClass().getQualifiedName() + "." + sym.name;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Returns a string representation of this method.  Includes the
duke@1:      * qualified signature, the qualified method name, and any type
duke@1:      * parameters.  Type parameters follow the class name, as they do
duke@1:      * in the syntax for invoking methods with explicit type parameters.
duke@1:      */
duke@1:     public String toString() {
duke@1:         return sym.enclClass().getQualifiedName() +
duke@1:                 "." + typeParametersString() + name() + signature();
duke@1:     }
duke@1: }