Tue, 22 Oct 2013 17:42:10 -0700
8027119: Cleanup javadoc comments for taglet API
Reviewed-by: mduigou
1 /*
2 * Copyright (c) 1998, 2012, Oracle and/or its affiliates. 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. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
26 package com.sun.javadoc;
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 {
36 /**
37 * Return true if this method is abstract
38 */
39 boolean isAbstract();
41 /**
42 * Return true if this method is default
43 */
44 boolean isDefault();
46 /**
47 * Get return type.
48 *
49 * @return the return type of this method, null if it
50 * is a constructor.
51 */
52 Type returnType();
54 /**
55 * Return the class containing the method that this method overrides.
56 *
57 * <p> <i>The <code>overriddenClass</code> method cannot
58 * accommodate certain generic type constructs. The
59 * <code>overriddenType</code> method should be used instead.</i>
60 *
61 * @return a ClassDoc representing the superclass
62 * defining a method that this method overrides, or null if
63 * this method does not override.
64 */
65 ClassDoc overriddenClass();
67 /**
68 * Return the type containing the method that this method overrides.
69 * It may be a <code>ClassDoc</code> or a <code>ParameterizedType</code>.
70 *
71 * @return the supertype whose method is overridden, or null if this
72 * method does not override another in a superclass
73 * @since 1.5
74 */
75 Type overriddenType();
77 /**
78 * Return the method that this method overrides.
79 *
80 * @return a MethodDoc representing a method definition
81 * in a superclass this method overrides, null if
82 * this method does not override.
83 */
84 MethodDoc overriddenMethod();
86 /**
87 * Tests whether this method overrides another.
88 * The overridden method may be one declared in a superclass or
89 * a superinterface (unlike {@link #overriddenMethod()}).
90 *
91 * <p> When a non-abstract method overrides an abstract one, it is
92 * also said to <i>implement</i> the other.
93 *
94 * @param meth the other method to examine
95 * @return <tt>true</tt> if this method overrides the other
96 * @since 1.5
97 */
98 boolean overrides(MethodDoc meth);
99 }