/*
 * Copyright (c) 1998, 2017, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.javadoc;

Represents a method of a java class.
Author:Robert Field
Since:1.2
Deprecated: The declarations in this package have been superseded by those in the package jdk.javadoc.doclet. For more information, see the Migration Guide in the documentation for that package.
/** * Represents a method of a java class. * * @since 1.2 * @author Robert Field * * @deprecated * The declarations in this package have been superseded by those * in the package {@code jdk.javadoc.doclet}. * For more information, see the <i>Migration Guide</i> in the documentation for that package. */
@Deprecated public interface MethodDoc extends ExecutableMemberDoc {
Return true if this method is abstract
Returns:true if this method is abstract
/** * Return true if this method is abstract * * @return true if this method is abstract */
boolean isAbstract();
Return true if this method is default
Returns:true if this method is default
/** * Return true if this method is default * * @return true if this method is default */
boolean isDefault();
Get return type.
Returns:the return type of this method, null if it is a constructor.
/** * Get return type. * * @return the return type of this method, null if it * is a constructor. */
Type returnType();
Return the class containing the method that this method overrides.

The overriddenClass method cannot accommodate certain generic type constructs. The overriddenType method should be used instead.

Returns:a ClassDoc representing the superclass defining a method that this method overrides, or null if this method does not override.
/** * Return the class containing the method that this method overrides. * * <p> <i>The {@code overriddenClass} method cannot * accommodate certain generic type constructs. The * {@code overriddenType} method should be used instead.</i> * * @return a ClassDoc representing the superclass * defining a method that this method overrides, or null if * this method does not override. */
ClassDoc overriddenClass();
Return the type containing the method that this method overrides. It may be a ClassDoc or a ParameterizedType.
Returns:the supertype whose method is overridden, or null if this method does not override another in a superclass
Since:1.5
/** * Return the type containing the method that this method overrides. * It may be a {@code ClassDoc} or a {@code ParameterizedType}. * * @return the supertype whose method is overridden, or null if this * method does not override another in a superclass * @since 1.5 */
Type overriddenType();
Return the method that this method overrides.
Returns:a MethodDoc representing a method definition in a superclass this method overrides, null if this method does not override.
/** * Return the method that this method overrides. * * @return a MethodDoc representing a method definition * in a superclass this method overrides, null if * this method does not override. */
MethodDoc overriddenMethod();
Tests whether this method overrides another. The overridden method may be one declared in a superclass or a superinterface (unlike overriddenMethod()).

When a non-abstract method overrides an abstract one, it is also said to implement the other.

Params:
  • meth – the other method to examine
Returns:true if this method overrides the other
Since:1.5
/** * Tests whether this method overrides another. * The overridden method may be one declared in a superclass or * a superinterface (unlike {@link #overriddenMethod()}). * * <p> When a non-abstract method overrides an abstract one, it is * also said to <i>implement</i> the other. * * @param meth the other method to examine * @return {@code true} if this method overrides the other * @since 1.5 */
boolean overrides(MethodDoc meth); }