ドックレット API

com.sun.javadoc
インタフェース MethodDoc

すべてのスーパーインタフェース:
Comparable<Object>, Doc, ExecutableMemberDoc, MemberDoc, ProgramElementDoc
既知のサブインタフェースの一覧:
AnnotationTypeElementDoc

public interface MethodDoc
extends ExecutableMemberDoc

特定の Java クラスの特定のメソッドを表します。

導入されたバージョン:
1.2

メソッドの概要
 boolean isAbstract()
          このメソッドが抽象メソッドの場合は、true を返します。
 ClassDoc overriddenClass()
          このメソッドがオーバーライドするメソッドを含むクラスを返します。
 MethodDoc overriddenMethod()
          このメソッドがオーバーライドするメソッドを返します。
 Type overriddenType()
          このメソッドがオーバーライドするメソッドを含む型を返します。
 boolean overrides(MethodDoc meth)
          このメソッドがほかのメソッドをオーバーライドするかどうかをテストします。
 Type returnType()
          戻り値の型を取得します。
 
インタフェース com.sun.javadoc.ExecutableMemberDoc から継承されたメソッド
flatSignature, isNative, isSynchronized, isVarArgs, parameters, paramTags, signature, thrownExceptions, thrownExceptionTypes, throwsTags, typeParameters, typeParamTags
 
インタフェース com.sun.javadoc.MemberDoc から継承されたメソッド
isSynthetic
 
インタフェース com.sun.javadoc.ProgramElementDoc から継承されたメソッド
annotations, containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName
 
インタフェース com.sun.javadoc.Doc から継承されたメソッド
commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isAnnotationType, isAnnotationTypeElement, isClass, isConstructor, isEnum, isEnumConstant, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, position, seeTags, setRawCommentText, tags, tags
 

メソッドの詳細

isAbstract

boolean isAbstract()
このメソッドが抽象メソッドの場合は、true を返します。


returnType

Type returnType()
戻り値の型を取得します。

戻り値:
このメソッドの戻り値の型。コンストラクタの場合は、null

overriddenClass

ClassDoc overriddenClass()
このメソッドがオーバーライドするメソッドを含むクラスを返します。

overriddenClass メソッドは特定の総称型の構造要素に対応できません。代わりに、overriddenType メソッドを使用する必要があります。

戻り値:
このメソッドがオーバーライドするメソッドが定義されているスーパークラスを表す ClassDoc、このメソッドがほかのメソッドをオーバーライドしない場合は null

overriddenType

Type overriddenType()
このメソッドがオーバーライドするメソッドを含む型を返します。返される型は、ClassDoc または ParameterizedType となる可能性があります。

戻り値:
メソッドがオーバーライドされるスーパータイプ、このメソッドが特定のスーパークラスでほかのメソッドをオーバーライドしない場合は null
導入されたバージョン:
1.5

overriddenMethod

MethodDoc overriddenMethod()
このメソッドがオーバーライドするメソッドを返します。

戻り値:
スーパークラス内の、このメソッドがオーバーライドするメソッド定義を表す MethodDoc。このメソッドがほかのメソッドをオーバーライドしない場合は null

overrides

boolean overrides(MethodDoc meth)
このメソッドがほかのメソッドをオーバーライドするかどうかをテストします。オーバーライドされるメソッドは、スーパークラス内またはスーパーインタフェース内で宣言されているメソッド (overriddenMethod() とは異なる) である可能性があります。

非 abstract メソッドが abstract メソッドをオーバーライドする場合、このメソッドはほかのメソッドを「実装する」とも言います。

パラメータ:
meth - テストの対象となるほかのメソッド
戻り値:
このメソッドがほかのメソッドをオーバーライドする場合は、true
導入されたバージョン:
1.5

ドックレット API

バグや機能要求の報告
Java は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2006 Sun Microsystems, Inc. 4150 Network Circle
Santa Clara, California, 95054, U.S.A. All Rights Reserved.