Mercurial > jdk8-mips64-public > langtools / file comparison
comparison: src/share/classes/com/sun/javadoc/MethodDoc.java
src/share/classes/com/sun/javadoc/MethodDoc.java
- changeset 1
- 9a66ca7c79fa
- child 554
- 9d9f26857129
equal
deleted
inserted
replaced
| -1:000000000000 | 1:9a66ca7c79fa |
|---|---|
| 1 /* | |
| 2 * Copyright 1998-2006 Sun Microsystems, Inc. All Rights Reserved. | |
| 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. | |
| 4 * | |
| 5 * This code is free software; you can redistribute it and/or modify it | |
| 6 * under the terms of the GNU General Public License version 2 only, as | |
| 7 * published by the Free Software Foundation. Sun designates this | |
| 8 * particular file as subject to the "Classpath" exception as provided | |
| 9 * by Sun in the LICENSE file that accompanied this code. | |
| 10 * | |
| 11 * This code is distributed in the hope that it will be useful, but WITHOUT | |
| 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 14 * version 2 for more details (a copy is included in the LICENSE file that | |
| 15 * accompanied this code). | |
| 16 * | |
| 17 * You should have received a copy of the GNU General Public License version | |
| 18 * 2 along with this work; if not, write to the Free Software Foundation, | |
| 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. | |
| 20 * | |
| 21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, | |
| 22 * CA 95054 USA or visit www.sun.com if you need additional information or | |
| 23 * have any questions. | |
| 24 */ | |
| 25 | |
| 26 package com.sun.javadoc; | |
| 27 | |
| 28 /** | |
| 29 * Represents a method of a java class. | |
| 30 * | |
| 31 * @since 1.2 | |
| 32 * @author Robert Field | |
| 33 */ | |
| 34 public interface MethodDoc extends ExecutableMemberDoc { | |
| 35 | |
| 36 /** | |
| 37 * Return true if this method is abstract | |
| 38 */ | |
| 39 boolean isAbstract(); | |
| 40 | |
| 41 /** | |
| 42 * Get return type. | |
| 43 * | |
| 44 * @return the return type of this method, null if it | |
| 45 * is a constructor. | |
| 46 */ | |
| 47 Type returnType(); | |
| 48 | |
| 49 /** | |
| 50 * Return the class containing the method that this method overrides. | |
| 51 * | |
| 52 * <p> <i>The <code>overriddenClass</code> method cannot | |
| 53 * accommodate certain generic type constructs. The | |
| 54 * <code>overriddenType</code> method should be used instead.</i> | |
| 55 * | |
| 56 * @return a ClassDoc representing the superclass | |
| 57 * defining a method that this method overrides, or null if | |
| 58 * this method does not override. | |
| 59 */ | |
| 60 ClassDoc overriddenClass(); | |
| 61 | |
| 62 /** | |
| 63 * Return the type containing the method that this method overrides. | |
| 64 * It may be a <code>ClassDoc</code> or a <code>ParameterizedType</code>. | |
| 65 * | |
| 66 * @return the supertype whose method is overridden, or null if this | |
| 67 * method does not override another in a superclass | |
| 68 * @since 1.5 | |
| 69 */ | |
| 70 Type overriddenType(); | |
| 71 | |
| 72 /** | |
| 73 * Return the method that this method overrides. | |
| 74 * | |
| 75 * @return a MethodDoc representing a method definition | |
| 76 * in a superclass this method overrides, null if | |
| 77 * this method does not override. | |
| 78 */ | |
| 79 MethodDoc overriddenMethod(); | |
| 80 | |
| 81 /** | |
| 82 * Tests whether this method overrides another. | |
| 83 * The overridden method may be one declared in a superclass or | |
| 84 * a superinterface (unlike {@link #overriddenMethod()}). | |
| 85 * | |
| 86 * <p> When a non-abstract method overrides an abstract one, it is | |
| 87 * also said to <i>implement</i> the other. | |
| 88 * | |
| 89 * @param meth the other method to examine | |
| 90 * @return <tt>true</tt> if this method overrides the other | |
| 91 * @since 1.5 | |
| 92 */ | |
| 93 boolean overrides(MethodDoc meth); | |
| 94 } |
