This is NOT part of any supported API.
jjg@1359: * If you write code that depends on this, you do so at your own risk.
jjg@1359: * This code and its internal interfaces are subject to change or
jjg@1359: * deletion without notice.
jjg@1359: *
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: */
jjg@1443: public MethodDocImpl(DocEnv env, MethodSymbol sym, TreePath treePath) {
jjg@1443: super(env, sym, treePath);
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: /**
vromero@1454: * Return true if this method is default
vromero@1454: */
vromero@1454: public boolean isDefault() {
vromero@1454: return (sym.flags() & Flags.DEFAULT) != 0;
vromero@1454: }
vromero@1454:
vromero@1454: /**
duke@1: * Return true if this method is abstract
duke@1: */
duke@1: public boolean isAbstract() {
bpatel@1476: return (Modifier.isAbstract(getModifiers()) && !isDefault());
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 ClassDoc or a ParameterizedType.
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);
jjg@1374: t.hasTag(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);
jjg@1374: t.hasTag(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: *
When a non-abstract method overrides an abstract one, it is duke@1: * also said to implement the other. duke@1: * duke@1: * @param meth the other method to examine duke@1: * @return true 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: }