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

すべてのスーパーインタフェース:

Comparable<Object>, Doc

既知のサブインタフェースの一覧:

AnnotationTypeDoc, AnnotationTypeElementDoc, ClassDoc, ConstructorDoc, ExecutableMemberDoc, FieldDoc, MemberDoc, MethodDoc

public interface ProgramElementDoc
extends Doc

Java プログラムの特定の要素 (クラス、インタフェース、フィールド、コンストラクタ、メソッドのいずれか) を表します。このインタフェースは、これらのプログラム要素に共通な情報を扱う abstract クラスです。

関連項目:

MemberDoc, ClassDoc

メソッドの概要

AnnotationDesc[]	annotations() このプログラム要素の注釈を取得します。
ClassDoc	containingClass() このプログラム要素を含んでいるクラスまたはインタフェースを取得します。
PackageDoc	containingPackage() このプログラム要素を含んでいるパッケージを取得します。
boolean	isFinal() このプログラム要素が final 指定されている場合は、true を返します。
boolean	isPackagePrivate() このプログラム要素が package private 指定されている場合は、true を返します。
boolean	isPrivate() このプログラム要素が private 指定されている場合は、true を返します。
boolean	isProtected() このプログラム要素が protected 指定されている場合は、true を返します。
boolean	isPublic() このプログラム要素が public 指定されている場合は、true を返します。
boolean	isStatic() このプログラム要素が static 指定されている場合は、true を返します。
String	modifiers() 修飾子の文字列を取得します。
int	modifierSpecifier() 修飾子を指定する整数を取得します。
String	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

メソッドの詳細

containingClass

ClassDoc containingClass()

このプログラム要素を含んでいるクラスまたはインタフェースを取得します。

戻り値:

この要素を含んでいるクラスまたはインタフェースの ClassDoc。 クラスまたはインタフェースがトップレベルの場合は null

containingPackage

PackageDoc containingPackage()

このプログラム要素を含んでいるパッケージを取得します。

戻り値:

この要素を含んでいるパッケージの PackageDoc。 名前のないパッケージでは、この PackageDoc は "" という名前になる

qualifiedName

String qualifiedName()

このプログラムの要素の完全指定名を取得します。たとえば、java.util.Hashtable クラスの場合、「java.util.Hashtable」を返します。

名前のないパッケージのクラスが Foo でメソッドが bar() の場合は、「Foo.bar」が返されます。

戻り値:

プログラム要素の String による修飾名

modifierSpecifier

int modifierSpecifier()

修飾子を指定する整数を取得します。

関連項目:

Modifier

modifiers

String modifiers()

修飾子の文字列を取得します。次に例を示します。

   public abstract int foo() { ... }
 

「public abstract」を返します。注釈は含まれません。

annotations

AnnotationDesc[] annotations()

このプログラム要素の注釈を取得します。注釈がない場合は、空の配列を返します。

戻り値:

このプログラム要素の注釈

導入されたバージョン:

1.5

isPublic

boolean isPublic()

このプログラム要素が public 指定されている場合は、true を返します。

isProtected

boolean isProtected()

このプログラム要素が protected 指定されている場合は、true を返します。

isPrivate

boolean isPrivate()

このプログラム要素が private 指定されている場合は、true を返します。

isPackagePrivate

boolean isPackagePrivate()

このプログラム要素が package private 指定されている場合は、true を返します。

isStatic

boolean isStatic()

このプログラム要素が static 指定されている場合は、true を返します。

isFinal

boolean isFinal()

このプログラム要素が final 指定されている場合は、true を返します。