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

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

Comparable, Doc, ProgramElementDoc, Type

public interface ClassDoc

extends ProgramElementDoc, Type

特定の Java クラスを表し、クラス、クラスのコメントとタグ、およびクラスのメンバに関する情報へのアクセスを提供します。ClassDoc は、javadoc の今回の実行で処理された場合にだけ存在します。この実行で処理されたかどうかにかかわらず、クラスへの参照は Type を使って参照されます (可能な場合には、Type を ClassDoc に変換可能)。

導入されたバージョン:

JDK1.2

関連項目:

Type

メソッドの概要

ConstructorDoc[]	constructors() このクラス内のコンストラクタを返します。
boolean	definesSerializableFields() Serializable フィールドが特別なクラスメンバ serialPersistentFields で明示的に定義されている場合は、true を返します。
FieldDoc[]	fields() クラス内のフィールドを返します。
ClassDoc	findClass(String className) このクラスのコンテキスト内で、特定のクラスを検索します。
ClassDoc[]	importedClasses() imported として宣言されたクラスのリストを取得します。
PackageDoc[]	importedPackages() imported として宣言されたパッケージのリストを取得します。
ClassDoc[]	innerClasses() このクラス内の内部クラスを返します。
ClassDoc[]	interfaces() このクラスで実装されているインタフェース、またはこのインタフェースで extends 節により拡張されているインタフェースを返します。
boolean	isAbstract() このクラスが abstract クラスの場合は、true を返します。
boolean	isExternalizable() このクラスで java.io.Externalizable を実装している場合は、true を返します。
boolean	isSerializable() このクラスで java.io.Serializable を実装している場合は、true を返します。
MethodDoc[]	methods() クラス内のメソッドを返します。
FieldDoc[]	serializableFields() クラスの Serializable フィールドを返します。
MethodDoc[]	serializationMethods() このクラスの直列化メソッドを返します。
boolean	subclassOf(ClassDoc cd) このクラスが指定されたクラスのサブクラスかどうかを調べます。
ClassDoc	superclass() このクラスのスーパークラスを返します。

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

containingClass, containingPackage, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, modifiers, modifierSpecifier, qualifiedName

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

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

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

asClassDoc, dimension, qualifiedTypeName, toString, typeName

メソッドの詳細

isAbstract

public boolean isAbstract()

このクラスが abstract クラスの場合は、true を返します。

isSerializable

public boolean isSerializable()

このクラスで java.io.Serializable を実装している場合は、true を返します。 java.io.Externalizable では extends 節により java.io.Serializable を拡張しているので、Externalizable オブジェクトは同時に Serializable オブジェクトになります。

isExternalizable

public boolean isExternalizable()

このクラスで java.io.Externalizable を実装している場合は、true を返します。

serializationMethods

public MethodDoc[] serializationMethods()

このクラスの直列化メソッドを返します。

戻り値:

このクラスの直列化メソッドを表す MethodDoc の配列

serializableFields

public FieldDoc[] serializableFields()

クラスの Serializable フィールドを返します。

serial タグでドキュメント化されたデフォルトフィールドのリストか、serialPersistentField メンバの FieldDoc を 1 つ返します。serialPersistentField の ObjectStreamField 配列の要素により定義された Serializable フィールドごとに serialField タグがあります。

戻り値:

このクラスの Serializable フィールドの FieldDoc の配列

関連項目:

definesSerializableFields(), SerialFieldTag

definesSerializableFields

public boolean definesSerializableFields()

Serializable フィールドが特別なクラスメンバ serialPersistentFields で明示的に定義されている場合は、true を返します。

関連項目:

serializableFields(), SerialFieldTag

superclass

public ClassDoc superclass()

このクラスのスーパークラスを返します。

戻り値:

このクラスのスーパークラスの ClassDoc。スーパークラスがない場合は、null

subclassOf

public boolean subclassOf(ClassDoc cd)

このクラスが指定されたクラスのサブクラスかどうかを調べます。

パラメータ:

cd - 対象となるスーパークラス

戻り値:

cd がこのクラスのスーパークラスの場合は、true

interfaces

public ClassDoc[] interfaces()

このクラスで実装されているインタフェース、またはこのインタフェースで extends 節により拡張されているインタフェースを返します。継承されたインタフェースではなく、直接宣言されたインターフェースだけが含まれます。

戻り値:

インタフェースを表す ClassDoc の配列。インタフェースがない場合は、空の配列

fields

public FieldDoc[] fields()

クラス内のフィールドを返します。

戻り値:

このクラス内の可視フィールドを表す FieldDoc の配列

methods

public MethodDoc[] methods()

クラス内のメソッドを返します。

戻り値:

このクラス内の可視メソッドを表す MethodDoc の配列。コンストラクタは対象外

constructors

public ConstructorDoc[] constructors()

このクラス内のコンストラクタを返します。ほかにコンストラクタがない場合は、引数を持たないデフォルトのコンストラクタを含む配列が返されます。

戻り値:

このクラス内の可視コンストラクタを表す ConstructorDoc の配列

innerClasses

public ClassDoc[] innerClasses()

このクラス内の内部クラスを返します。

戻り値:

このクラス内で定義されている可視クラスを表す ClassDoc の配列。匿名クラスとローカルクラスは対象外

findClass

public ClassDoc findClass(String className)

このクラスのコンテキスト内で、特定のクラスを検索します。検索は、修飾名、このクラス (内部クラス)、このパッケージ、インポートされたクラス、インポートされたパッケージの順で行われます。クラスが見つかった場合はその ClassDoc を返し、見つからなかった場合は null を返します。

importedClasses

public ClassDoc[] importedClasses()

imported として宣言されたクラスのリストを取得します。このような宣言を JLS では「シングルタイプインポート宣言」と呼びます。

戻り値:

imported として宣言されたクラスを表す ClassDoc の配列

importedPackages

public PackageDoc[] importedPackages()

imported として宣言されたパッケージのリストを取得します。このような宣言を JLS では「オンデマンドタイプインポート宣言」と呼びます。

戻り値:

imported として宣言されたパッケージを表す PackageDoc の配列