Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/javadoc/MethodDoc.java@9a66ca7c79fa (annotated)
src/share/classes/com/sun/javadoc/MethodDoc.java
Sat, 01 Dec 2007 00:00:00 +0000
- author
- duke
- date
- Sat, 01 Dec 2007 00:00:00 +0000
- changeset 1
- 9a66ca7c79fa
- child 554
- 9d9f26857129
- permissions
- -rw-r--r--
Initial load
| duke@1 | 1 | /* |
| duke@1 | 2 | * Copyright 1998-2006 Sun Microsystems, Inc. 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 |
| duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| duke@1 | 9 | * by Sun 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 | * |
| duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| duke@1 | 23 | * have any questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.javadoc; |
| duke@1 | 27 | |
| duke@1 | 28 | /** |
| duke@1 | 29 | * Represents a method of a java class. |
| duke@1 | 30 | * |
| duke@1 | 31 | * @since 1.2 |
| duke@1 | 32 | * @author Robert Field |
| duke@1 | 33 | */ |
| duke@1 | 34 | public interface MethodDoc extends ExecutableMemberDoc { |
| duke@1 | 35 | |
| duke@1 | 36 | /** |
| duke@1 | 37 | * Return true if this method is abstract |
| duke@1 | 38 | */ |
| duke@1 | 39 | boolean isAbstract(); |
| duke@1 | 40 | |
| duke@1 | 41 | /** |
| duke@1 | 42 | * Get return type. |
| duke@1 | 43 | * |
| duke@1 | 44 | * @return the return type of this method, null if it |
| duke@1 | 45 | * is a constructor. |
| duke@1 | 46 | */ |
| duke@1 | 47 | Type returnType(); |
| duke@1 | 48 | |
| duke@1 | 49 | /** |
| duke@1 | 50 | * Return the class containing the method that this method overrides. |
| duke@1 | 51 | * |
| duke@1 | 52 | * <p> <i>The <code>overriddenClass</code> method cannot |
| duke@1 | 53 | * accommodate certain generic type constructs. The |
| duke@1 | 54 | * <code>overriddenType</code> method should be used instead.</i> |
| duke@1 | 55 | * |
| duke@1 | 56 | * @return a ClassDoc representing the superclass |
| duke@1 | 57 | * defining a method that this method overrides, or null if |
| duke@1 | 58 | * this method does not override. |
| duke@1 | 59 | */ |
| duke@1 | 60 | ClassDoc overriddenClass(); |
| duke@1 | 61 | |
| duke@1 | 62 | /** |
| duke@1 | 63 | * Return the type containing the method that this method overrides. |
| duke@1 | 64 | * It may be a <code>ClassDoc</code> or a <code>ParameterizedType</code>. |
| duke@1 | 65 | * |
| duke@1 | 66 | * @return the supertype whose method is overridden, or null if this |
| duke@1 | 67 | * method does not override another in a superclass |
| duke@1 | 68 | * @since 1.5 |
| duke@1 | 69 | */ |
| duke@1 | 70 | Type overriddenType(); |
| duke@1 | 71 | |
| duke@1 | 72 | /** |
| duke@1 | 73 | * Return the method that this method overrides. |
| duke@1 | 74 | * |
| duke@1 | 75 | * @return a MethodDoc representing a method definition |
| duke@1 | 76 | * in a superclass this method overrides, null if |
| duke@1 | 77 | * this method does not override. |
| duke@1 | 78 | */ |
| duke@1 | 79 | MethodDoc overriddenMethod(); |
| duke@1 | 80 | |
| duke@1 | 81 | /** |
| duke@1 | 82 | * Tests whether this method overrides another. |
| duke@1 | 83 | * The overridden method may be one declared in a superclass or |
| duke@1 | 84 | * a superinterface (unlike {@link #overriddenMethod()}). |
| duke@1 | 85 | * |
| duke@1 | 86 | * <p> When a non-abstract method overrides an abstract one, it is |
| duke@1 | 87 | * also said to <i>implement</i> the other. |
| duke@1 | 88 | * |
| duke@1 | 89 | * @param meth the other method to examine |
| duke@1 | 90 | * @return <tt>true</tt> if this method overrides the other |
| duke@1 | 91 | * @since 1.5 |
| duke@1 | 92 | */ |
| duke@1 | 93 | boolean overrides(MethodDoc meth); |
| duke@1 | 94 | } |
