MethodDoc.java revision 4150:fff0714129d8 
1/*
2 * Copyright (c) 1998, 2017, 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 */
25
26package com.sun.javadoc;
27
28/**
29 * Represents a method of a java class.
30 *
31 * @since 1.2
32 * @author Robert Field
33 *
34 * @deprecated
35 *   The declarations in this package have been superseded by those
36 *   in the package {@code jdk.javadoc.doclet}.
37 *   For more information, see the <i>Migration Guide</i> in the documentation for that package.
38 */
39@Deprecated
40public interface MethodDoc extends ExecutableMemberDoc {
41
42    /**
43     * Return true if this method is abstract
44     *
45     * @return true if this method is abstract
46     */
47    boolean isAbstract();
48
49    /**
50     * Return true if this method is default
51     *
52     * @return true if this method is default
53     */
54    boolean isDefault();
55
56    /**
57     * Get return type.
58     *
59     * @return the return type of this method, null if it
60     * is a constructor.
61     */
62    Type returnType();
63
64    /**
65     * Return the class containing the method that this method overrides.
66     *
67     * <p> <i>The {@code overriddenClass} method cannot
68     * accommodate certain generic type constructs.  The
69     * {@code overriddenType} method should be used instead.</i>
70     *
71     * @return a ClassDoc representing the superclass
72     *         defining a method that this method overrides, or null if
73     *         this method does not override.
74     */
75    ClassDoc overriddenClass();
76
77    /**
78     * Return the type containing the method that this method overrides.
79     * It may be a {@code ClassDoc} or a {@code ParameterizedType}.
80     *
81     * @return the supertype whose method is overridden, or null if this
82     *         method does not override another in a superclass
83     * @since 1.5
84     */
85    Type overriddenType();
86
87    /**
88     * Return the method that this method overrides.
89     *
90     * @return a MethodDoc representing a method definition
91     * in a superclass this method overrides, null if
92     * this method does not override.
93     */
94    MethodDoc overriddenMethod();
95
96    /**
97     * Tests whether this method overrides another.
98     * The overridden method may be one declared in a superclass or
99     * a superinterface (unlike {@link #overriddenMethod()}).
100     *
101     * <p> When a non-abstract method overrides an abstract one, it is
102     * also said to <i>implement</i> the other.
103     *
104     * @param meth  the other method to examine
105     * @return {@code true} if this method overrides the other
106     * @since 1.5
107     */
108    boolean overrides(MethodDoc meth);
109}
110