gw.gosudoc.com.sun.javadoc.MethodDoc Maven / Gradle / Ivy
Show all versions of gosu-doc Show documentation
/*
* This file is a shadowed version of the older javadoc codebase on which gosudoc is based; borrowed from jdk 9.
*/
package gw.gosudoc.com.sun.javadoc;
/**
* 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 Migration Guide in the documentation for that package.
*/
@Deprecated
public interface MethodDoc extends ExecutableMemberDoc
{
/**
* Return true if this method is abstract
*
* @return true if this method is abstract
*/
boolean isAbstract();
/**
* Return true if this method is default
*
* @return true if this method is default
*/
boolean isDefault();
/**
* Get return type.
*
* @return the return type of this method, null if it
* is a constructor.
*/
gw.gosudoc.com.sun.javadoc.Type returnType();
/**
* Return the class containing the method that this method overrides.
*
* The {@code overriddenClass} method cannot
* accommodate certain generic type constructs. The
* {@code overriddenType} method should be used instead.
*
* @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 {@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.
*
* @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 {@link #overriddenMethod()}).
*
*
When a non-abstract method overrides an abstract one, it is
* also said to implement 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);
}