1 /*

     2  * Copyright (c) 1998, 2018, 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 

    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  * @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(since="9", forRemoval=true)

    40 @SuppressWarnings("removal")

    41 public interface MethodDoc extends ExecutableMemberDoc {

    42 

    43     /**

    44      * Return true if this method is abstract

    45      *

    46      * @return true if this method is abstract

    47      */

    48     boolean isAbstract();

    49 

    50     /**

    51      * Return true if this method is default

    52      *

    53      * @return true if this method is default

    54      */

    55     boolean isDefault();

    56 

    57     /**

    58      * Get return type.

    59      *

    60      * @return the return type of this method, null if it

    61      * is a constructor.

    62      */

    63     Type returnType();

    64 

    65     /**

    66      * Return the class containing the method that this method overrides.

    67      *

    68      * <p> <i>The {@code overriddenClass} method cannot

    69      * accommodate certain generic type constructs.  The

    70      * {@code overriddenType} method should be used instead.</i>

    71      *

    72      * @return a ClassDoc representing the superclass

    73      *         defining a method that this method overrides, or null if

    74      *         this method does not override.

    75      */

    76     ClassDoc overriddenClass();

    77 

    78     /**

    79      * Return the type containing the method that this method overrides.

    80      * It may be a {@code ClassDoc} or a {@code ParameterizedType}.

    81      *

    82      * @return the supertype whose method is overridden, or null if this

    83      *         method does not override another in a superclass

    84      * @since 1.5

    85      */

    86     Type overriddenType();

    87 

    88     /**

    89      * Return the method that this method overrides.

    90      *

    91      * @return a MethodDoc representing a method definition

    92      * in a superclass this method overrides, null if

    93      * this method does not override.

    94      */

    95     MethodDoc overriddenMethod();

    96 

    97     /**

    98      * Tests whether this method overrides another.

    99      * The overridden method may be one declared in a superclass or

   100      * a superinterface (unlike {@link #overriddenMethod()}).

   101      *

   102      * <p> When a non-abstract method overrides an abstract one, it is

   103      * also said to <i>implement</i> the other.

   104      *

   105      * @param meth  the other method to examine

   106      * @return {@code true} if this method overrides the other

   107      * @since 1.5

   108      */

   109     boolean overrides(MethodDoc meth);

   110 }