diff -r 000000000000 -r 9a66ca7c79fa src/share/classes/com/sun/javadoc/MethodDoc.java --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/share/classes/com/sun/javadoc/MethodDoc.java Sat Dec 01 00:00:00 2007 +0000 @@ -0,0 +1,94 @@ +/* + * Copyright 1998-2006 Sun Microsystems, Inc. All Rights Reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Sun designates this + * particular file as subject to the "Classpath" exception as provided + * by Sun in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, + * CA 95054 USA or visit www.sun.com if you need additional information or + * have any questions. + */ + +package com.sun.javadoc; + +/** + * Represents a method of a java class. + * + * @since 1.2 + * @author Robert Field + */ +public interface MethodDoc extends ExecutableMemberDoc { + + /** + * Return true if this method is abstract + */ + boolean isAbstract(); + + /** + * Get return type. + * + * @return the return type of this method, null if it + * is a constructor. + */ + Type returnType(); + + /** + * Return the class containing the method that this method overrides. + * + *
The overriddenClass
method cannot
+ * accommodate certain generic type constructs. The
+ * overriddenType
method should be used instead.
+ *
+ * @return a ClassDoc representing the superclass
+ * defining a method that this method overrides, or null if
+ * this method does not override.
+ */
+ ClassDoc overriddenClass();
+
+ /**
+ * Return the type containing the method that this method overrides.
+ * It may be a ClassDoc
or a ParameterizedType
.
+ *
+ * @return the supertype whose method is overridden, or null if this
+ * method does not override another in a superclass
+ * @since 1.5
+ */
+ Type overriddenType();
+
+ /**
+ * Return the method that this method overrides.
+ *
+ * @return a MethodDoc representing a method definition
+ * in a superclass this method overrides, null if
+ * this method does not override.
+ */
+ MethodDoc overriddenMethod();
+
+ /**
+ * Tests whether this method overrides another.
+ * The overridden method may be one declared in a superclass or
+ * a superinterface (unlike {@link #overriddenMethod()}).
+ *
+ *
When a non-abstract method overrides an abstract one, it is + * also said to implement the other. + * + * @param meth the other method to examine + * @return true if this method overrides the other + * @since 1.5 + */ + boolean overrides(MethodDoc meth); +}