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

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

java.lang.Comparable, Doc, java.io.Serializable

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

ClassDoc, ConstructorDoc, ExecutableMemberDoc, FieldDoc, MemberDoc, MethodDoc

public interface ProgramElementDoc

extends Doc

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

関連項目:

MemberDoc, ClassDoc

メソッドの概要

ClassDoc	containingClass() このプログラム要素を含んでいるクラスを取得します。
PackageDoc	containingPackage() このプログラム要素を含んでいるパッケージを取得します。
boolean	isFinal() このプログラム要素が final 指定されている場合は、true を返します。
boolean	isPackagePrivate() このプログラム要素がパッケージ内で有効な要素である場合は、true を返します。
boolean	isPrivate() このプログラム要素が private 指定されている場合は、true を返します。
boolean	isProtected() このプログラム要素が protected 指定されている場合は、true を返します。
boolean	isPublic() このプログラム要素が public 指定されている場合は、true を返します。
boolean	isStatic() このプログラム要素が static 指定されている場合は、true を返します。
java.lang.String	modifiers() 修飾子の文字列を取得します。
int	modifierSpecifier() 修飾子を指定する整数を取得します。
java.lang.String	qualifiedName() 完全修飾名を取得します。

インタフェース com.sun.javadoc.Doc から継承したメソッド

commentText, compareTo, firstSentenceTags, getRawCommentText, inlineTags, isClass, isConstructor, isError, isException, isField, isIncluded, isInterface, isMethod, isOrdinaryClass, name, seeTags, setRawCommentText, tags, tags

メソッドの詳細

containingClass

public ClassDoc containingClass()

このプログラム要素を含んでいるクラスを取得します。

戻り値:

この要素を含んでいるクラスの ClassDoc。このクラスの外部クラスがない場合は、null

containingPackage

public PackageDoc containingPackage()

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

戻り値:

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

qualifiedName

public java.lang.String qualifiedName()

完全修飾名を取得します。

例:
クラスが java.util.Hashtable の場合は、java.util.Hashtable が返されます。
指定されていないパッケージのクラスが Foo でメソッドが bar() の場合は、Foo.bar() が返されます。
 

戻り値:

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

modifierSpecifier

public int modifierSpecifier()

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

関連項目:

Modifier

modifiers

public java.lang.String modifiers()

修飾子の文字列を取得します。

 例:
 public abstract int foo() { ... } の場合は、public abstract が返されます。
 

isPublic

public boolean isPublic()

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

isProtected

public boolean isProtected()

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

isPrivate

public boolean isPrivate()

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

isPackagePrivate

public boolean isPackagePrivate()

このプログラム要素がパッケージ内で有効な要素である場合は、true を返します。

isStatic

public boolean isStatic()

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

isFinal

public boolean isFinal()

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